iOS常用代码规范(持续更新)

代码规范尽量遵循以下规则，持续补充——2022-01-20

1、单文件代码区域规范

从上往下划依次为（如下图所示）

• 公开方法
• 私有方法
• 响应事件
• 自定义代理方法
• 系统代理方法
• 初始化方法(包含setter/getter)
• 生命周期方法

截图.png

2、打包规范

开发包命名规范：

测试环境包

BL_2.0.16_20210101_lp_Dev01
项目名缩写_版本号_时间_开发者姓名缩写_Dev01/_Dev02/...

正式环境包

BL_2.0.16_20210101_lp_01
项目名缩写_版本号_时间_开发者姓名缩写_01/02/...

线上环境包

BL_2.0.16_20210101_lp_Online01
项目名缩写_版本号_时间_开发者姓名缩写_Online01/Online02/...

3、UI规范

尽量按照UI设计稿规范

4、注释规范

• 文件开头需要注释此文件用途

/// 用户主页
@interface BLTalentHomepageVC

• 每个属性需要注释用途，例如：

/// 用户nodeid
@property (nonatomic,copy)NSString *nodeid;

• 每个方法要注释用途，例如：

/// 点击右上角更多按钮
- (void)clickMoreAction{

}

• 关键逻辑或认为比较重要的地方要注释

5、代码规范

文件名、枚举、宏等要求首字母大写，其他地方遵循驼峰原则

6、git规范

• 提交message：增删改分别不同前缀

-added：增加内容
-changed：修改内容
-deleted：删除内容

• 尽量每天下班前提交代码
• 每个项目只有master主支、develop分支、test预发布分支

a. 平常都是在develop分支上操作
b. 开发中的工作都在develop基础上拉分支或者工作流，完成后合并到 develop，develop没问题后再合并到test预发布测试一次
c. 最后测试无误，test合并到master并发布APP，发布完APP在master要打对应版本号的tag
d. 其他临时分支或者工作流完成合并后就删除