第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运用挨次定名规矩
版权声明: 原创作品,许可转载,转载时请务必以超链接方式标明文章 原始来由 、作者信息和本声明。否则将究查法律责任。