第3章 命名法例
较劲有名的命名法例当推Microsoft公司的“匈牙利”法,该命名法例的主要头脑是“在变量和函数名中参与前缀以增进人们对步伐的认识探询”。比方悉数的字符变量均以ch为前缀,若是指针变量则追加前缀p。假定一个变量由ppch收尾,则批注它是指向字符指针的指针。
“匈牙利”法最年夜的缺陷是啰嗦,比方
int i, j, k;
float x, y, z;
倘若假定采纳“匈牙利”命名法例,则应当写成
int iI, iJ, ik; // 前缀 i暗示int典型榜样
float fX, fY, fZ; // 前缀 f暗示float典型榜样
云云啰嗦的步伐会让绝年夜少数步伐员无法忍耐。
据考查,没有一种命名法例可以让悉数的步伐员赞同,步伐操持教科书普通都不指定命名法例。命名法例对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图创作发明天下上最好的命名法例,而应当拟订一种令年夜少数项目成员骄傲的命名法例,并在项目中贯彻尝试。
3.1 个性法例
本节阐述的个性法例是被年夜少数步伐员采纳的,我们应当在依照这些个性法例的条件下,再扩年夜特定的法例,如3.2节。
l 【法例3-1-1】标识符应当直不雅且可以拼读,可望文知意,不用住手“解码”。
标识符最好采纳英文单词或其组合,便于记忆和阅读。切忌运用汉语拼音来命名。步伐中的英文单词普通不会太伟年夜,用词应当正确。比方不要把CurrentValue写成NowValue。
l 【法例3-1-2】标识符的长度应当符合“min-length && max-information”准绳。
几十年前老ANSI C规命名字不准超越6个字符,现今的C /C不再有此限制。普通来说,长名字能更好地表达寄义,所以函数名、变量名、类名长达十几个字符缺乏为怪。那么名字可否越长约好?不见得! 比方变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是无效的,罕见的如i,j,k,m,n,x,y,z等,它们屡屡可用作函数内的部分变量。
l 【法例3-1-3】命名法例只管与所采纳的操纵体系或拓荒对象的派头派头坚持平等。
比方Windows利用步伐的标识符屡屡采纳“年夜小写”混排的体例,如AddChild。而Unix利用步伐的标识符屡屡采纳“小写加下划线”的体例,如add_child。别把这两类派头派头混在一同用。
l 【法例3-1-4】步伐中不要出现仅靠年夜小写区分的相通的标识符。
比方:
int x, X; // 变量x 与 X 随便搅浑
void foo(int x); // 函数foo 与FOO随便搅浑
void FOO(float x);
l 【法例3-1-5】步伐中不要出现标识符完全相反的部分变量和全局变量,虽然两者的熏染域分歧而不会发生语法错误,但会使人误解。
l 【法例3-1-6】变量的名字应当运用“名词”可以“描写词+名词”。
比方:
float value;
float oldValue;
float newValue;
l 【法例3-1-7】全局函数的名字应当运用“动词”可以“动词+名词”(动宾词组)。类的成员函数应当只运用“动词”,被省略失的名词便是对象本人。
比方:
DrawBox(); // 全局函数
box->Draw(); // 类的成员函数
l 【法例3-1-8】用正确的反义词组命名具有互斥意义的变量或相反方法的函数等。
比方:
int minValue;
int maxValue;
int SetValue(…);
int GetValue(…);
² 【提倡3-1-1】只管避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需求编号。这是为了灌注步伐员偷懒,不愿为命名动头脑而招致发生计心义的名字(由于用数字编号最省事)。
3.2 复杂的Windows利用步伐命名法例
作者对“匈牙利”命名法例做了合理的简化,下述的命名法例复杂易用,较劲适当于Windows利用软件的拓荒。
l 【法例3-2-1】类名和函数名用年夜写字母收尾的单词组合而成。
比方:
> // 类名
> // 类名
void Draw(void); // 函数名
void SetValue(int value); // 函数名
l 【法例3-2-2】变量和参数用小写字母收尾的单词组合而成。
比方:
BOOL flag;
int drawMode;
l 【法例3-2-3】常量全用年夜写的字母,用下划线朋分单词。
比方:
const int MAX = 100;
const int MAX_LENGTH = 100;
l 【法例3-2-4】静态变量加前缀s_(暗示static)。
比方:
void Init(…)
{
static int s_initValue; // 静态变量
…
}
l 【法例3-2-5】假定不得已需责备局变量,则使全局变量加前缀g_(暗示global)。
比方:
int g_howManyPeople; // 全局变量
int g_howMuchMoney; // 全局变量
l 【法例3-2-6】类的数据成员加前缀m_(暗示member),如许可以避免数据成员与成员函数的参数同名。
比方:
void Object::SetValue(int width, int height)
{
m_width = width;
m_height = height;
}
l 【法例3-2-7】为了灌注某一软件库中的一些标识符和其它软件库中的争持,可认为各种标识符加上能反应软件性子的前缀。比方三维图形尺度OpenGL的悉数库函数均以gl收尾,悉数常量(或宏界说)均以GL收尾。
3.3 复杂的Unix利用步伐命名法例
版权声明: 原创作品,许可转载,转载时请务必以超链接措施标明文章 原始来由 、作者信息和本声明。否则将追究执法责任。