上一章命名规范约定了良好命名的基本样子,这一章通用命名规则讲述改怎样去命名,以及为什么以这样的规则去命名。 通用命名规则: (1)函数命名、变量命名、文件命名应具有描述性,不要过度缩写 好的例子
int errorNumber;
string bookName;
坏的例子
int e;
string bn;
不要为了节省空间而使用不明确的缩写。 除非是放在项目外面也能明确含义的缩写,比如DNS、IP、MAC等等,否则就不要使用缩写。 也不要使用省略字母的缩写,比如 counter 不要写成 cnt (2)类和变量应该是名词,函数名采用动词+名词。函数通常是指令性的,如果是获取数据的函数需要描述的更加细致,与要获取的内容量吻合。 好的例子
class Log {
function readLog() {}
}
不好的例子
class Lo {
function logReader()
}
尽可能给出描述性名词,提高代码可读性,目标是让别人快速理解。 禁止使用模糊的缩写或随意的字符。