代码规范

使空格不使Tab

  • 不要在工程里使用Tab键,使用空格来进行缩进。在Xcode > Preferences > Text Editing将Tab和自动缩进都设置为4个空格。

每行最大长

  • 在Xcode > Preferences > Text Editing > Page guide at column:中将最大行长设置为80,过长的一行代码将会导致可读性问题。

函数书写

  • 在-和(void)之间应该有一个空格,第一个大括号{的位置在函数所在行的末尾,同样应该有一个空格:
- (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {  

}
  • 函数参数来对齐分行显示:
- (id)initWithModel:(IPCModle)model      ConnectType:(IPCConnectType)connectType       
                                          Resolution:(IPCResolution)resolution         
                                            AuthName:(NSString *)authName         
                                            Password:(NSString *)password               
                                                 MAC:(NSString *)mac            
                                                AzIp:(NSString *)az_ip             
                                               AzDns:(NSString *)az_dns             
                                               Token:(NSString *)token            
                                               Email:(NSString *)email        
                                            Delegate:(id)delegate;
  • 在分行时,如果第一段名称过短,后续名称可以以Tab的长度(4个空格)为单位进行缩进:
- (void)short:(GTMFoo *)theFoo       longKeyword:(NSRect)theRect evenLongerKeyword:(float)theInterval             error:(NSError **)theError {   ...}

函数调用

  • 按照函数的长短来选择写在一行或者分成多行
//写在一行
[myObject doFooWith:arg1 name:arg2 error:arg3];

//分行写,按照':'对齐
[myObject doFooWith:arg1
               name:arg2
              error:arg3];

//第一段名称过短的话后续可以进行缩进
[myObj short:arg1
          longKeyword:arg2
    evenLongerKeyword:arg3
                error:arg4];

  • @public和@private标记符以一个空格进行缩进

@interface MyClass : NSObject {
 @public
  ...
 @private
  ...
}
@end

命名规范

  • 清晰

命名应该尽可能的清晰和简洁,但在Objective-C中,清晰比简洁更重要。由于Xcode强大的自动补全功能,我们不必担心名称过长的问题。

//清晰
insertObject:atIndex:

//不清晰,insert的对象类型和at的位置属性没有说明
insert:at:

//清晰
removeObjectAtIndex:

//不清晰,remove的对象类型没有说明,参数的作用没有说明
remove:

//清晰
destinationSelection
setBackgroundColor:

//不清晰,不要使用简写
destSel
setBkgdColor:

//有歧义,是返回sendPort还是send一个Port?
sendPort

//有歧义,是返回一个名字属性的值还是display一个name的动作?
displayName

然而,有部分单词简写在Objective-C编码过程中是非常常用的,以至于成为了一种规范,这些简写可以在代码中直接使用,下面列举了部分:

alloc   == Allocate                 max    == Maximum
alt     == Alternate                min    == Minimum
app     == Application              msg    == Message
calc    == Calculate                nib    == Interface Builder archive
dealloc == Deallocate               pboard == Pasteboard
func    == Function                 rect   == Rectangle
horiz   == Horizontal               Rep    == Representation (used in class name such as NSBitmapImageRep).
info    == Information              temp   == Temporary
init    == Initialize               vert   == Vertical
int     == Integer
  • 前缀

如果代码需要打包成Framework给别的工程使用,或者工程项目非常庞大,需要拆分成不同的模块,使用命名前缀是非常有用的。

前缀由大写的字母缩写组成,比如Cocoa中NS。前缀代表Founation框架中的类,IB则代表Interface Builder框架。

可以在为类、协议、函数、常量以及typedef宏命名的时候使用前缀,但注意不要为成员变量或者方法使用前缀,因为他们本身就包含在类的命名空间内。

命名前缀的时候不要和苹果SDK框架冲突。

  • 命名类和协议(Class&Protocol)

类名以大写字母开头,应该包含一个名词来表示它代表的对象类型,同时可以加上必要的前缀,比如NSString, NSDate, NSScanner, NSApplication等等。

而协议名称应该清晰地表示它所执行的行为,而且要和类名区别开来,所以通常使用ing
词尾来命名一个协议,比如NSCopying,NSLocking

有些协议本身包含了很多不相关的功能,主要用来为某一特定类服务,这时候可以直接用类名来命名这个协议,比如NSObject协议,它包含了id对象在生存周期内的一系列方法。

  • 命名头文件(Headers)

源码的头文件名应该清晰地暗示它的功能和包含的内容:

1、如果头文件内只定义了单个类或者协议,直接用类名或者协议名来命名头文件,比如NSLocale.h定义了NSLocale类。

2、如果头文件内定义了一系列的类、协议、类别,使用其中最主要的类名来命名头文件,比如NSString.h定义了NSStringNSMutableString

3、每一个Framework都应该有一个和框架同名的头文件,包含了框架中所有公共类头文件的引用,比如Foundation.h

4、Framework中有时候会实现在别的框架中类的类别扩展,这样的文件通常使用被扩展的框架名+Additions的方式来命名,比如NSBundleAdditions.h

  • 命名方法(Methods)

Objective-C的方法名通常都比较长,这是为了让程序有更好地可读性,按苹果的说法“好的方法名应当可以以一个句子的形式朗读出来”

你可能感兴趣的:(代码规范)