【iOS 搭建基础框架】编码规范 (命名规范篇)本篇是 iOS 搭建基础框架系列，第一部分编码规范的第一篇命名规

本篇是 iOS 搭建基础框架 系列，第一部分 编码规范 的第一篇 命名规范篇。

其他相关文章传送门如下：

本篇内容，摘取自苹果、谷歌的文档翻译，还有网上大神们贡献的资料。

主要是为了让自己保持代码的一致性 and 传说中的优雅 🙂

希望能让你有所收获，没有收获也没关系，记得点赞~ 🙂

命名规范

类名 (Class)

避免潜在的命名冲突，设置 Class Prefix

设置整个项目的统一类名前缀。由于苹果公司保留使用"两个字母前缀"的所有权，所以项目里的前缀应取三个字母为宜。
类名的命名采用 大驼峰命名法 即每个单词的首字母大写。

类别 (Category)

如下：类别名添加 大写前缀 KL ，方法名添加 小写前缀 kl 。

NSObject+KLNetworkingMethods.h

@interface NSObject (KLNetworkingMethods)

- (BOOL)kl_isEmptyObject;

@end

委托 (Delegate)

第一个参数是触发委托的对象
第一个关键词是触发对象的类名
除非该方法只有一个参数

// 第一个关键词为触发委托的类名
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section;  

// 当只有一个"sender"参数时可以省略类名
- (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;

根据委托方法触发的时机和目的，使用should,will,did等关键词

- (void)browserDidScroll:(NSBrowser *)sender;

- (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;、

- (BOOL)windowShouldClose:(id)sender;

通知 (Notification)

通知常用于在模块间传递消息，所以通知要尽可能地表示出发生的事件，通知的命名范式是：

[触发通知的类名] + [Did | Will] + [动作] + Notification

栗子🌰

NSApplicationDidBecomeActiveNotification
UIKeyboardWillShowNotification
NSUserDefaultsDidChangeNotification
UITextFieldTextDidBeginEditingNotification

常量或者宏

常量：k为前缀，后续遵循 驼峰命名法， kConstantName
宏：全部使用大写字母加下划线的形式，MACORS_NAME

方法(Methods)

命名采用 小驼峰命名法 即首个单词全部用小写字母，后续的单词首字母大写。

方法名中不应该有标点符号(包括下划线)，除了以下的情况：

可以用带下划线的小写前缀来命名私有方法或者类别中的方法

- (void)kl_setControls

如果方法表示让对象执行一个动作，使用动词打头来命名，注意不要使用do，does这种多余的关键字，动词本身的暗示就足够了：

//正确，使用属性名来命名方法
- (NSSize)cellSize;

//错误，添加了多余的动词前缀
- (NSSize)calcCellSize;
- (NSSize)getCellSize;

对于有多个参数的方法，务必在每一个参数前都添加关键词，关键词应当清晰说明参数的作用：

//正确，保证每个参数都有关键词修饰
- (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;

//错误，遗漏关键词
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;

//正确
- (id)viewWithTag:(NSInteger)aTag;

//错误，关键词的作用不清晰
- (id)taggedView:(int)aTag;

不要用and来连接两个参数，通常and用来表示方法执行了两个相对独立的操作（从设计上来说，这时候应该拆分成两个独立的方法）：

//错误，不要使用"and"来连接参数
- (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes;

//正确，使用"and"来表示两个相对独立的操作
- (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;

方法的参数命名也有一些需要注意的地方:

和方法名类似，参数的第一个字母小写，后面的每一个单词首字母大写
不要再方法名中使用类似pointer,ptr这样的字眼去表示指针，参数本身的类型足以说明
不要使用只有一两个字母的参数名
不要使用简写，拼出完整的单词

存取方法（Accessor Methods）

存取方法是指用来获取和设置类属性值的方法，属性的不同类型，对应着不同的存取方法规范：

//属性是一个名词时的存取方法范式
- (type)noun;
- (void)setNoun:(type)aNoun;
//栗子
- (NSString *)title;
- (void)setTitle:(NSString *)aTitle;

//属性是一个形容词时存取方法的范式
- (BOOL)isAdjective;
- (void)setAdjective:(BOOL)flag;
//栗子
- (BOOL)isEditable;
- (void)setEditable:(BOOL)flag;

//属性是一个动词时存取方法的范式
- (BOOL)verbObject;
- (void)setVerbObject:(BOOL)flag;
//栗子
- (BOOL)showsAlpha;
- (void)setShowsAlpha:(BOOL)flag;

命名存取方法时不要将动词转化为被动形式来使用：

//正确
- (void)setAcceptsGlyphInfo:(BOOL)flag;
- (BOOL)acceptsGlyphInfo;

//错误，不要使用动词的被动形式
- (void)setGlyphInfoAccepted:(BOOL)flag;
- (BOOL)glyphInfoAccepted;

可以使用can,should,will等词来协助表达存取方法的意思，但不要使用do,和does：

//正确
- (void)setCanHide:(BOOL)flag;
- (BOOL)canHide;
- (void)setShouldCloseDocument:(BOOL)flag;
- (BOOL)shouldCloseDocument;

//错误，不要使用"do"或者"does"
- (void)setDoesAcceptGlyphInfo:(BOOL)flag;
- (BOOL)doesAcceptGlyphInfo;

为什么 Objective-C 中不适用get前缀来表示属性获取方法？因为get在 Objective-C 中通常只用来表示从函数指针返回值的函数：

//三个参数都是作为函数的返回值来使用的，这样的函数名可以使用"get"前缀
- (void)getLineDash:(float *)pattern count:(int *)count phase:(float *)phase;

集合操作类方法（Collection Methods）

有些对象管理着一系列其它对象或者元素的集合，需要使用类似“增删查改”的方法来对集合进行操作，这些方法的命名范式一般为：

//集合操作范式
- (void)addElement:(elementType)anObj;
- (void)removeElement:(elementType)anObj;
- (NSArray *)elements;

//栗子
- (void)addLayoutManager:(NSLayoutManager *)obj;
- (void)removeLayoutManager:(NSLayoutManager *)obj;
- (NSArray *)layoutManagers;

注意，如果返回的集合是无序的，使用NSSet来代替NSArray。如果需要将元素插入到特定的位置，使用类似于这样的命名：

- (void)insertLayoutManager:(NSLayoutManager *)obj atIndex:(int)index;
- (void)removeLayoutManagerAtIndex:(int)index;

如果管理的集合元素中有指向管理对象的指针，要设置成weak类型以防止引用循环。

下面是SDK中NSWindow类的集合操作方法：

- (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place;
- (void)removeChildWindow:(NSWindow *)childWin;
- (NSArray *)childWindows;
- (NSWindow *)parentWindow;
- (void)setParentWindow:(NSWindow *)window;

命名属性和实例变量（Properties&Instance Variables）

属性和对象的存取方法相关联，属性的第一个字母小写，后续单词首字母大写，不必添加前缀。属性按功能命名成名词或者动词：

//名词属性
@property (strong) NSString *title;

//动词属性
@property (assign) BOOL showsAlpha;

属性也可以命名成形容词，这时候通常会指定一个带有is前缀的get方法来提高可读性：

@property (assign, getter=isEditable) BOOL editable;

命名实例变量，在变量名前加上_前缀（有些有历史的代码会将_放在后面），其它和命名属性一样：

@implementation MyClass {
    BOOL _showsTitle;
}

一般来说，类需要对使用者隐藏数据存储的细节，所以不要将实例方法定义成公共可访问的接口，可以使用@private，@protected前缀。

按苹果的说法，不建议在除了init和dealloc方法以外的地方直接访问实例变量，但很多人认为直接访问会让代码更加清晰可读，只在需要计算或者执行操作的时候才使用存取方法访问，我就是这种习惯，所以这里不作要求。

###命名常量（Constants）

如果要定义一组相关的常量，尽量使用枚举类型（enumerations），枚举类型的命名规则和函数的命名规则相同。建议使用 NS_ENUM 和 NS_OPTIONS 宏来定义枚举类型，参见官方的 Adopting Modern Objective-C 一文：

//定义一个枚举
typedef NS_ENUM(NSInteger, NSMatrixMode) {
    NSRadioModeMatrix,
    NSHighlightModeMatrix,
    NSListModeMatrix,
    NSTrackModeMatrix
};

定义bit map：

typedef NS_OPTIONS(NSUInteger, NSWindowMask) {
    NSBorderlessWindowMask      = 0,
    NSTitledWindowMask          = 1 << 0,
    NSClosableWindowMask        = 1 << 1,
    NSMiniaturizableWindowMask  = 1 << 2,
    NSResizableWindowMask       = 1 << 3
};

使用const定义浮点型或者单个的整数型常量，如果要定义一组相关的整数常量，应该优先使用枚举。常量的命名规范和函数相同：

const float NSLightGray;

不要使用#define宏来定义常量，如果是整型常量，尽量使用枚举，浮点型常量，使用const定义。#define通常用来给编译器决定是否编译某块代码，比如常用的：

#ifdef DEBUG

注意到一般由编译器定义的宏会在前后都有一个__，比如*__MACH__*。

注释

文件注释

每一个文件都必须写文件注释，文件注释最基本的应包含

文件名称
作者信息(姓名、邮箱、Github等)
文件的描述，及其作用
版本信息

最基础的文件注释栗子🌰

/*******************************************************************************

    File name:     AppDelegate.h
    Author:        Ferryman (Li KaiLong)
 
    Description:
 
    History:

 
 ********************************************************************************/

在 Xcode 里，创建的新文件都有默认的文件注释，可通过 Xcode 9 的 自定义文本宏 新特性统一添加我们的文件注释模块，保持整个工程统一的文件注释风格。 重要！很重要！！非常重要！！！

统一文件注释模块添加的技巧可参考我这篇【iOS 小技巧】Xcode自定义文件头部注释

代码注释

“自解释”（self-documenting）的代码是我们应该做到的，但仍然需要详细的注释来说明参数的意义、返回值、功能以及可能的副作用。

方法、类、协议、类别的定义都需要注释，推荐采用Apple的标准注释风格，好处是可以在引用的地方option + 鼠标左键自动弹出注释，非常方便。

生成注释格式的方法采用 Xcode 自带的注释快捷键功能

单行注释：在需要注释的地方按 command + /
标注：在属性或者方法名的上面(空白) 的地方按 command + option + /

特别注意：

协议、委托的注释要明确说明其被触发的条件
如果在注释中要引用参数名或者方法函数名，使用||将参数或者方法括起来以避免歧义：

定义在头文件里的接口方法、属性必须要有注释！

哥们，都浪到这了，顺手点个赞❤️呗~

【iOS 搭建基础框架】编码规范 (命名规范篇)