如何编写高质量的程序 命名规则

本文介绍了程序设计中标识符的命名规则,包括变量名、函数名及类名等的命名建议,强调了命名应直观易懂,避免混淆,并提供了一些具体的示例。

标志符的命名规则
我们在编写程序的时候,不可避免的涉及到这个问题,变量名,函数名,类名等等。简单明了的标识符能增强

我们程序的可读性,不过这个命名规则永远没有一个统一的准确的标准,但是我们还是可以找到一些通用的规

则的。
【规则】标识符应当直观且可以拼读,可望文知意。标识符最好采用英文单词或其组合,便于记忆和阅读。切

忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue 写成

NowValue。
【规则】标识符的长度应当符合“min-length && max-information”原则
【规则】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。例如Windows 应用程序的标识符通常

采用“大小写”混排的方式,如AddChild。而Unix 应用程序的标识符通常采用“小写加下划线”的方式,如

add_child。别把这两类风格混在一起用。
【规则】程序中不要出现仅靠大小写区分的相似的标识符。

【规则】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误

,但会使人误解。
【规则】变量的名字应当使用“名词”或者“形容词+名词”。

【规则】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应当只使用“动

词”,被省略掉的名词就是对象本身。
例如:
DrawBox(); // 全局函数
box->Draw(); // 类的成员函数
【规则】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
例如:
int minValue;
int maxValue;
int SetValue(…);
int GetValue(…);
【建议】尽量避免名字中出现数字编号,如Value1,Value2 等,除非逻辑上的确需要编号。

3.2 简单的Windows 应用程序命名规则


【规则】类名和函数名用大写字母开头的单词组合而成。

【规则】变量和参数用小写字母开头的单词组合而成。

【规则】常量全用大写的字母,用下划线分割单词。

【规则】静态变量加前缀s_(表示static)

static int s_initValue; // 静态变量

【规则】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。
int g_howManyPeople; // 全局变量

【规则】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。

(这一点很重要!)

例如:
void Object::SetValue(int width, int height)
{
m_width = width;
m_height = height;
}
【规则】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质

的前缀。例如三维图形标准OpenGL 的所有库函数均以gl 开头,所有常量(或宏定义)均以GL 开头。


 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值