代码规范
王通 3/2/2021 iOS代码规范
# 文档修订记录
| 序号 | 修改时间 | 修改人 | 版本 | 备注 |
|---|---|---|---|---|
| 1 | 2020.09.02 | 王通 | V1.0.0 | 初稿 |
# 类前缀
类前缀目的：为了解决类冲突
NH：互联网医院
HC：健康通
# 类命名规范
类命名要添加前缀，采用驼峰命名方式
# 类头部注释
示例一：
/**
* 类注释
*/
@interface NHXxxxxxClass : NSObject
@end
1
2
3
4
5
6
2
3
4
5
6
示例二：
/**
* 类注释
*
* 类详细描述
*/
@interface NHXxxxxxClass : NSObject
@end
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
示例三：
/// 类注释
@interface NHXxxxxxClass : NSObject
@end
1
2
3
4
2
3
4
示例四：
/// 类注释
///
/// 类详细描述
@interface NHXxxxxxClass : NSObject
@end
1
2
3
4
5
6
2
3
4
5
6
# 变量命名规范，采用驼峰方式命名
Model: modelXxx, mXxx
NSString: strXxx
NSAttributedString: aStrXxx
NSMutableAttributedString: mAStrXxx
NSNumber: numXxx
NSSet: setXxx
UILabel: lbXxx
UIButton: btnXxx
UIImageView: ivXxx
UIView: viewXxx
UIImage: imageXxx, imgXxx
UITextView: tvXxx
UITextField: tfXxx
NSLayoutConstraint: cstBtnXxxWidth
NSArray: arrayXxx, arrXxx
NSMutableArray: mArrXxx, mArrayXxx
UIScrollView: svXxx
UITableView: tableViewXxx, tbvXxx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 属性命名规范，采用驼峰方式命名
@property (nonatomic, strong) NSString *strXxx;
@property (nonatomic, copy) NSString *strXxx;
1
2
2
# 函数命名规范
函数命名，采用驼峰方式命名
注意: 大括号写法, 开始大括号在函数右边(非函数下边)
注意: 不做命名规范，采用驼峰即可
- (void)funcXxx {
}
1
2
2
事件函数：
- (void)onXxx {
}
1
2
2
多参数函数：
- (void)funcXxxWithParamAaa:(NSString *)paramAaa
paramBbb:(NSString *)paramBbb {
}
1
2
3
2
3
枚举值
注意: 注释写法
/**
注释
*/
typedef NS_ENUM(NSUInteger, MyEnum) {
/** aaa */
MyEnum_Aaa,
/** bbb */
MyEnum_Bbb,
/** ccc */
MyEnum_Ccc
};
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 注释
单行，顶部注释方式一：
/// 注释
1
单行，顶部注释方式二：
/**
* 注释
*/
1
2
3
2
3
多行，顶部注释方式三：
/// <#描述#>
///
/// <#详细描述#>
///
/// @param <#参数#> <#参数描述#>
/// @param <#参数#> <#参数描述#>
/// @return <#返回参数#>
1
2
3
4
5
6
7
2
3
4
5
6
7
多行，顶部注释方式四：
/**
* <#描述#>
*
* <#详细描述#>
*
* @param <#参数#> <#参数描述#>
* @param <#参数#> <#参数描述#>
* @return <#返回参数描述#>
*/
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9