《OC编程规约.docVIP

Objective-C 编程规约 by-- 熊学江 1.? 目的 1 2.? 规范内容 2 3.? 参考资料 12 1.? 目的 一个软件的生命周期中有百分之八十的时间是在维护。 几乎没有哪个软件是完全由它的原担当来进行维护的。 编码规范可以提高代码的可读性，可以让其他人员理解得更快，更清晰。 在开发产品的时候， 需要保持所有产品之间的风格一致性。 2.? 规范内容 2.1代码格式 使用空格而不是制表符 Tab 不要在工程里使用 Tab 键，使用空格来进行缩进。在 Xcode Preferences Text Editing 将 Tab 和自动缩进都设置为?4?个空格。（Google 的标准是使用两个空格来缩进，但这里还是推荐使用 Xcode 默认的设置。） 每一行的最大长度 同样的，在 Xcode Preferences Text Editing Page guide at column: 中将最大行长设置为?80?，过长的一行代码将会导致可读性问题。 函数的书写一个典型的 Objective-C 函数应该是这样的： -?(void)writeVideoFrameWithData:(NSData?*)frameData?timeStamp:(int)timeStamp?{ ... }在 - 和 (void) 之间应该有一个空格，第一个大括号 { 的位置在函数所在行的末尾，同样应该有一个空格。 如果一个函数有特别多的参数或者名称很长，应该将其按照 : 来对齐分行显示：-(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?{ ... } 2.1命名规范 基本原则 清晰 命名应该尽可能的清晰和简洁，但在 Objective-C 中，清晰比简洁更重要。由于 Xcode 强大的自动补全功能，我们不必担心名称过长的问题。 //?清晰 insertObject:atIndex: //?不清晰，?insert?的对象类型和?at?的位置属性没有说明 insert:at: //?清晰 removeObjectAtIndex: //?不清晰，?remove?的对象类型没有说明，参数的作用没有说明 remove: 不要使用单词的简写，拼写出完整的单词：//?清晰 destinationSelection setBackgroundColor: //?不清晰，不要使用简写 destSel setBkgdColor: 然而，有部分单词简写在 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