命名风格直接确定的命名实体是:类型、变量、函数、常量、宏等等,无需查找实体声明,人体大脑的模式匹配引擎依赖于这些命名规则。
1、通用命名规则
函数命名、变量命名、文件名命名具有描述性,不能过度缩写,类型和变量名应为名词,函数名应用“命令性”动词。
尽可能给出描述性名称,不能节约空间,让别人很快理解你的代码:
int num_errors; //good
int num_completed_connections; //good
丑陋的命名使用模糊的缩写或随意的字符:
int n; //Bad-meaningless
int nerr; //Bad-ambiguous abbreviation.
int n_comp_conns; //Bad-ambiguous abbreviation.
类型和变量名一般是名词:如FileOpener、num_errors。
函数名一般是指令性的,如OpenFile()、set_num_errors(),访问函数需要描述的更细致, 要与其访问的变量相吻合。
缩写:
除非放到项目外也非常明了,否则不要使用缩写,例如:
// Good
// These show proper names with no abbreviations.
int num_dns_connections; // M