所有类名,接口名(Protocol)均以大写字母开头,多单词组合时,后面的单词首写字母大写。
View, 所有扩展自UIView的类以View结尾,如: LabelView, GridView。
ViewController,所有扩展自UIViewController的类以ViewController线 ,如, HomePageViewControler, LoginViewController。
Model,所有保存数据的实体类以Model结尾,如,UserModel,用户保存所有用户相关的信息,如姓名,性别等
在类中的成员变量以小写字母开头,多单词组合时,后面的单词首写字母大写。
如: userName,userAge...
方法名以小写字母开头,多单词组合时,后面的单词首写字母大写。
如: doAction, fetchUser...
任何文件的命名尽量不要以中文命名。
开头带有一个下划线(“_”)的名称通常由库函数(“_main”和“_exit”)使用。开头带有两个下划线(“__”)或一个下划线后接一个大写字母的名称保留给编译器内部使用。
名称还要避免下划线相邻,否则很难识别下划线的确切个数。
只通过大小写才能区分的类型名称,它们间的差异是很难记忆的,也就很容易造成混淆。
应用领域中常用的缩写(如 FFT 指快速傅立叶变换),或在项目缩写清单中有定义的缩写,才能使用相应的缩写。否则,很有可能相似但不相同的缩写到处出现,之后就引进了混淆和错误(如将 trackIdentification 缩写成 trid、trck_id、tr_iden、tid、tr_ident等)。
从应用的角度选择名称,名词使用形容词修饰来提高局部(具体上下文)的含义。确保名称与其类型保持一致。
选择合适的名称,使以下结构:
objectName.FunctionName(...);
objectName->FunctionName(...);
[objectName FunctionName(...);
易于阅读并有实际含义。
不要使用短名称或缩写名称,也不要太长,以免编译截断名称。使用人们熟知的 E 作为自然对数的底数或 Pi 作为圆周率是例外。
示例:
原代码: void SetForegroundColor(CColor fg) 读者直觉上会认为 fg 意指 foreground(前景);但是,任何一个好的编程风格都不应留给读者作直觉推导的余地。 void SetForegroundColor(CColor foreground) { theForegroundColor = foreground; } 当使用参数 foreground(远离其声明)时,读者会认为foreground 实际上就是指 foreground 的颜色。可以想象,它能代表任何一种可暗中转化为color的类型。 |
推荐风格: void SetColor(CColor newColor) { ... theColor = newColor; ... } 对 newColor 进行了限定使它与其类型一致;因此增强了函数的语义。 |
英语字符名称部分应正确的拼写,遵守项目要求的形式,如使用一致的英国英语或美国英语,但不能同时使用。这对注释也同样适用。
对布尔值类型的对象、函数及函数实参使用正值形式的判定句式,如FoundIt、IsAvailable,但不使用IsNotAvailable。
使用简单形式的常用名词或名词短语,为类取名时要表达出它的抽象含义。基类使用更通用的名称,而对派生类使用更专用的名称。
typedef ... Reference; //出自标准库
typedef ... Pointer; //出自标准库
typedef ... Iterator; //出自标准库
struct tagPoint{....};
class CBankAccount {...};
class CSavingsAccount : public CBankAccount {...};
class CCheckingAccount : public CBankAccount {...};
如:CGlobalLocation,CFont,CDialog
结构名加小写前缀"tag",结构“}”之后其后每一个单词都以大写字母开头
例:
typedef struct tagPoint
{
int nx;
int ny;
} Point;
枚举名前加小写字母“enu”,在“}”之后全部大写,单词之间以下划线“_”相连。
全部大写
例:
typedef enum enuKFILE_OPEN_MODE
{
OPEN_READONLY = 0,
OPEN_READWRITE = 1,
CREATE_ALWAY = 3
} KFILE_OPEN_MODE;
如:CColorDlg,CEditView,COleServerDoc等。
变量名的命名遵从匈牙利记法。即:前缀 + 类型 + 变量名
[m_|g_] type [class name|struct name] variable name
如:long nTemp; //normal
long NTemp; //abnormal
LPCTSTR lpszMenuName;
声明常量,宏,枚举常量时应全部使用大写字母,单词之间以单下划线相连。
如:const double PAI=3.1415926; //noraml
const double Pai=3.1415926; //abnoraml
#define PAI 3.1415926 //normal
#define Pai 3.1415926 //abnormal
enum Color{RED,BLUE,GREEN}; //normal
enum Color{red,blue,green}; //abnormal
变量名大小应至少2~3个以上的字母,避免单字母变量。当变量单纯作为整型循环变量时,可以使用单个字母。如:i,j,k等。
例:chrName,hWnd等。
如:icu_nNumber,dom_chrSelect.
如:g_nNumber,g_nSelect.
如:pMemDC,pGUIFactory,g_pCtrl 。
对象变量命名除了具备普通变量的规则,还包括:
如:m_bConnection,m_chrName 。
如:ms_bConnection,ms_chrName 。
如:dlgFileOpen,strName,mainWnd,memDC
如果类/结构没有缩写命名,不用加类/结构名前后缀。
如 localHttpProxy,domSomeObject,newPlan;
应该用一致的前(后)缀来命名同一类对象(或指向对象的指针),使人们容易识别对象(指针)的类型。
示例
void Insert(...);
void Erase(...);
Name FirstName();
bool HasFirstName();
bool IsFound();
bool IsAvailable();
示例
bool IsNotValid(...);
void FindClient(CName withTheName, bool& notFound);
Should be re-defined as:
bool IsValid(...);
void FindClient(CName withTheName, bool& found);
当需要使用同一通用含义时,使用函数的重载
当操作目的相同时,使用重载而不使用同义词;这尽量减少了系统中概念的数量和不同的操作,因此也就降低了整体的复杂性。
当重载操作符时,要确保操作符的语义保留了下来;如果不能保留约定俗成的操作符含义,则为函数选用另一个名称而不使用操作符重载方式。