(十九)[OC高效系列]使用清晰而协调的命名方式

1.方法的命名规范,以NSString和NSMutableString为例

• 如果方法是新创建的
  • 方法的第一个名字应该是其返回类型

    + (instancetype)string;
    + (instancetype)stringWithString:(NSString *)string;
    + (instancetype)stringWithCharacters:(const unichar *)characters length:(NSUInteger)length;

• 返回类型之前还可以加一些修饰词

    - (NSString *)substringFromIndex:(NSUInteger)from;

• 属性的存取方法应该以属性名来命名

  - (NSUInteger)length;

• 当通过输出参数来返回返回值，而不是通过返回值来返回返回值的方法需要加上get的前缀

  - (void)getCharacters:(unichar *)buffer range:(NSRange)range; 

• 返回值是boolean的方法应该加上is前缀

  - (BOOL)isEqualToString:(NSString *)aString;

• 如果方法要在当前对象操作，那么就应该包含动词，如果有参数，那就应该在动词后面加上一个或者多个参数

  //NSMutableString
  - (void)appendString:(NSString *)aString;

2.类和协议的命名规范

• 类和协议应该有前缀

NSArray、UIView

• 如果是继承，子类的末尾应该和父类保持一致

NSArray : NSMutableArray 
UIView : UIImageView、UITableView ..

• 委托协议应该包含委托方的名称

UITableView : UITableViewDelegate

3.为私有方法加上名称前缀

• 优点
  • 可以清楚的将公共方法与私有方法区分开
• 注意点
  • 不要单用一个下划线做私有方法的前缀，因为这是苹果公司专用，如果用了可能会将父类中的私有方法给覆盖掉
  • 可以使用自己的前缀作为私有方法的前缀