征服iOS

cocoa 编程指南(一)——代码命名基础

2017-09-05  本文已影响14人  夏天的风_song

面前对象软件库的设计经常被忽略的一个方便是类,方法,函数,常量以及编程接口的其他元素的命名。本章节讨论Cocoa界面的大多数项目通用的几个命名约定。

一般原则

明晰

尽可能清晰简洁是很好的,但是清晰度不应该由于简洁而受损

1.png

一般来说,不要缩写名称。尽可能的拼出来,尽管它们可能很长

2.png

您可能认为缩写是中所周知的,但是可能不是这样,特别是遇到您的方法或函数名称的是具有不同的文化和语言背景的开发人员。

然而,一些缩略是真正常见的,具有悠久的使用历史。您可以继续使用它们;请参阅 Acceptable Abbreviations and Acronyms

** 避免API名称中的歧义,例如可以以多种方式解释的方法名称。**

3.png

一致性

** 尝试在整个Cocoa编程接口中使用名称。如果您不确定,请浏览当前头文件或参考文档以获取先例**

当你有一个类的方法需要利用多态时,一致性时特别重要的。在不同类中执行相同的操作方法,应该具有相同的名称

4.png

另请参见Method Arguments

非自我引用

名称不应该时自引用的

5.png

作为掩码(因此可以按位操作组合)的常量是此规则的一个例外,通知名称的常量也是例外。

6.png

前缀

前缀是编程接口中名称的重要组成部分。它们区分软件的功能区域。通常这个软件包装在一个框架中,或者在紧密相关的框架中(如基金会和应用程序包的情况)。前缀可防止第三方开发人员和Apple定义的符号之间的冲突(以及Apple自己的框架中的符号之间)。

前缀具有规定的格式。它由两个或三个大写字母组成,不使用下划线或“子前缀”。以下是一些示例

7

命名类,协议,函数,常量和typedef结构时使用前缀。千万不能命名方法时,使用前缀;方法存在于定义它们的类创建的命名空间中。另外,不要使用前缀来命名结构的字段。

排版约束

命名API元素时,请遵循一些简单的排版约定:

fileExistsAtPath:isDirectory:

这个指南的一个例外是以一个著名的首字母缩写开头的方法名称,例如TIFFRepresentation(NSImage)。

NSRunAlertPanel
NSCellDisabled

类和协议名称

一个类的名字应该明确指出类(或类的对象)代表或做什么的名词。该名称应该有一个适当的前缀。基础和应用框架充满了实例;例如:NSString,NSDate,NSScanner,NSApplication,UIApplication,NSButton,和UIButton。

协议应根据他们的行为组合来命名:

8

这种协议的一个例子是NSobject协议。此协议的分组的方法可以用于查询其在类层次结构中的位置的任何对象,以使其调用特定方法,并增加或减少其引用计数。因为NSObject类提供了这些方法的主要表达式,所以协议以类命名。

头文件

如何命名头文件很重要,因为您使用的约定表示文件包含了什么:

9 10 11
上一篇 下一篇

猜你喜欢

热点阅读