apple官方oc代码的命名规范

OC苹果官方标准

一、 通用标准Apple文档地址：

1. 命名要精简且语义清晰（可读性高），不能为了精简牺牲可读性.
   比如：方法 insertObject:atIndex: 相比 insert:at :来说，可读性高；removeObject:和removeObjectAtIndex：相比remove:来说可读性高。

2. 不能使用单词的缩写命名.
   比如：destinationSelection相比destSel来讲，可读性更高。

3. 标准2的例外：一些常用的单词缩写，可以继续使用.
   比如：alloc func max rect等常用名词。

4. 避免可能引起歧义的命名.
   比如:sendPort 函数名，让人搞不清是函数功能是发送一个port还是返回port。

5. 与cocoa代码的接口命名保持一致，尤其是在自己编写的具有多态性类的方法时。
   比如：initWithFrame等方法，其他方法可以参考cocoa的头文件。

6. 前缀的使用范围.
   前缀由一个以上的大写字母组成，如UI，NS等。前缀可以用在类名，协议名，函数名，常数名，typedef的结构体名；不要用在类的方法名中，也不要用于结构体（未typedef）。

二、 类名和协议名规范apple文档

协议名不能与类名混淆，即协议名听起来不能像类名。通用的方式是使用动名词来命名协议。比如，NSLocking比NSLock更合适作为协议名，因为前者更不像类名。

三、 头文件命名规范apple文档

1. 声明的类（或类别、协议）不是一个类（或类别，协议）的集合时，应该将类（或类别，协议）声明在一个独立的头文件中。
   例如：NSLocal.h中只声明NSLocal类。

2. 声明的类（或类别、协议）属于一个类（或类别，协议）的集合时，将所有类（或类别，协议）放在一起，某个头文件中。
   例如： NSString.h文件中，声明了NSString和NSMutableString类。

3. 包含框架头文件时，每个框架应该对应一个头文件
   例如：Foundation.framework位于Foundation.h头文件中。

4. 相关的函数，常量，结构体，和其他数据类型，应该定义在同一个头文件中。
   例如：NSGraphics.h头文件中声明的是绘图相关的函数，常量等。
   四、 方法命名规范Apple文档链接

5. 命名方法的时候，避免使用前缀，应该以小写字母打头。
   避免 NSLock样式的用法，应使用 initWithFrame的驼峰式。

6. 方法实现的内容是执行某个操作时，方法名的开头应为动词
   例如：- (void)invokeWithTarget:(id)target;方法。
   不要使用do或does作为名字的一部分，不要将形容词或副词放在动词前。

7. 属性的读写方法中的读方法，不必使用get等前缀
   例如：方法 - (NSSize)cellSize;返回cell尺寸
   不必写成： - (NSSize)getCellSize;

8. 对于多个参数的方法，每个参数应使用关键词修饰
   例如：- (void)sendAction:(SEL)aSelector
   toObject:(id)anObject
   forAllCells:(BOOL)flag;
   而不能写成- (void)sendAction:(SEL)aSelector
   :(id)anObject
   :(BOOL)flag;

9. 方法名中，位于形参之前的词应该修饰参数
   例如：- (id)viewWithTag:(NSInteger)aTag;
   而不应该写成 - (id)taggedView:(int)aTag;

10. 继承于已存在的方法，并且较已存在的方法参数更多，使用范围更细致的方法，应将新增的参数加在已存在函数的后面
    例如：- (id)initWithFrame:(CGRect)frameRect;和

• (id)initWithFrame:(NSRect)frameRect
  mode:(int)aMode
  cellClass:(Class)factoryId
  numberOfRows:(int)rowsHigh
  numberOfColumns:(int)colsWide;

11. 不要使用and连接相关联的属性
    例如：- (int)runModalForDirectory:(NSString *)path
    file:(NSString *) name
    types:(NSArray *)fileTypes;
    而不要写成：

• (int)runModalForDirectory:(NSString *)path
  andFile:(NSString *)name
  andTypes:(NSArray *)fileTypes;

12. 应该使用and连接两个无关联的动作

• (BOOL)openFile:(NSString *)fullPath
  withApplication:(NSString *)appName
  andDeactivate:(BOOL)flag;

13. 属性的读写方法：
    如果属性是一个名词，他的读写方法应该写成如下形式：
    - (NSString *)title;
    - (void)setTitle:(NSString *)aTitle;
    如果属性是一个形容词，读写方法应写成如下形式：
    - (BOOL)isEditable;
    - (void)setEditable:(BOOL)flag;
    如果属性是一个动词，其读写方法应该如下形式：
    - (BOOL)showsAlpha;
    - (void)setShowsAlpha:(BOOL)flag;

14. 当方法中包含的动词的过去分词为形容词时，不要使用过去分词
    例如： - (void)setAcceptsGlyphInfo:(BOOL)flag;
    不要写成 - (void)setGlyphInfoAccepted:(BOOL)flag;

15. 可以使用情态动词 can，should，will等，而不要使用do或does

16. 在方法同时返回（或同时修改）多个值时，方法名使用get为开头。
    如：- (void)getLineDash:(float *)pattern
    count:(int *)count
    phase:(float *)phase;

17. 委托方法（委托协议）命名
    方法开头应该是能标识调用此方法的类的对象。
    例如： - (BOOL)tableView:(NSTableView *)tableView
    shouldSelectRow:(int)row;和
    - (BOOL)application:(NSApplication *)sender
    openFile:(NSString *)filename;

18. 使用will或did来表示委托方法要运行，或已经运行
    例如：- (void)browserDidScroll:(NSBrowser *)sender;
    - (void)viewWillAppear:(BOOL)animated;

19. 表示集合的类的方法命名规范
    集合类应该具备增删元素，返回全部元素的方法
    例如：- (void)addLayoutManager:(NSLayoutManager *)obj;
    - (void)removeLayoutManager:(NSLayoutManager *)obj;
    - (NSArray *)layoutManagers;
    如果集合类中元素为无序的，返回类型应该是NSSet而不应是NSArray类型。

需要在集合中间添加删除元素时，方法应该使用：
- (void)insertLayoutManager:(NSLayoutManager *)obj
atIndex:(int)index;
- (void)removeLayoutManagerAtIndex:(int)index;形式

20. 方法的参数命名规范
    首字母小写，驼峰形式；不要使用pointer或者ptr在参数名中；避免使用只包含一个或两个字母的参数名；不要使用只省略了几个字母的单词缩写。
    ﾎ蝪｢ 函数，属性，常量等的命名规范Apple官方地址：
    1.区别于类方法的命名方式，函数命名有两点明显区别：
    有固定的前缀，如NSHighlight；紧挨前缀之后的首字母大写。
    尽量以函数的作用或影响来给函数命名，并以动词开头，如
    float NSHeight(NSRect aRect)。
    如果函数的返回值是引用类型，在函数名中使用get，如
    const char *NSGetSizeAndAlignment(const char *typePtr, unsigned int
    *sizep, unsigned int *alignp)
    2.属性是bool类型的，除非强调成员变量的读属性，否则使用is打头。
    3.常量的命名规范
    值为整型的互相关联的数个常量，应该写在命名的枚举类型中。
    如：
    typedef enum _NSMatrixMode {
    NSRadioModeMatrix = 0,
    NSHighlightModeMatrix = 1,
    NSListModeMatrix = 2,
    NSTrackModeMatrix = 3
    } NSMatrixMode;

    可以使用未命名的枚举，针对位掩码的赋值，如
    enum {
    NSBorderlessWindowMask = 0,
    NSTitledWindowMask = 1 << 0,
    NSClosableWindowMask = 1 << 1,
    NSMiniaturizableWindowMask = 1 << 2,
    NSResizableWindowMask = 1 << 3
    };

六．其他命名规范
不要使用#define来声明常量。对应整型的常数，应使用命名的枚举来定义；对于浮点数常量，应该用const关键词修饰。

预编译 #ifdef 定义的名，应使用全大写的单词，如 #ifdef DEBUG

由编译器生成的宏，其前后应有双下划线标识，如MACH

通知的命名规范。
形式如下：
相关的类 + [did或will] + 名字中唯一标识 + Notification
如，NSApplicationDidBecomeActiveNotification