原创 高质量C/C++——变量函数命名规则

2014-10-29 16:14 1128 18 18 分类: MCU/ 嵌入式 文集: 嵌入式

    第一次发表博客,希望在这里和大家分享自己的总结,和大家共同进步。

    命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。
 
【规则 1】标识符应当直观且可以拼读,可望文知意,不必进行“解码” 。 
标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把 CurrentValue 写成NowValue。 
【规则 2】标识符的长度应当符合“min-length && max-information”原则。
标示符长度不是越长越好,而是要精简,一看就能明白你这个变量和函数的意思和作用。比如:变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z.
【规则 3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。 
例如 Windows 应用程序的标识符通常采用“大小写”混排的方式,如 AddChild。而Unix 应用程序的标识符通常采用“小写加下划线”的方式,如 add_child。别把这两类风格混在一起用。 (这一点要特别注意,很多人在定义变量的时候是喜欢混在一起乱用的,如果想让自己的代码简洁易懂,就按照这种方式去命名再好不过了)
【规则 4】程序中不要出现仅靠大小写区分的相似的标识符。 
【规则 5】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。同时也不要出现完全相同变量名和函数名,万一函数出现问题,比如没定义,编译器会提示这个函数出现错误,有时你会误以为是变量出现错误。
【规则 6】变量的名字应当使用“名词”或者“形容词+名词”。
例如: 
float  value; 
float  oldValue; 
float  newValue; 
【规则 7】全局函数的名字应当使用“动词”或者“动词+名词” (动宾词组) 。
类的成员函数应当只使用“动词” ,被省略掉的名词就是对象本身。 
例如: 
DrawBox();  //  全局函数 
  box->Draw();  //  类的成员函数 
【规则 8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 
例如: 
int minValue; 
int maxValue; 
 
int SetValue(…); 
int GetValue(…); 
【建议 9】尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)

文章评论0条评论)

登录后参与讨论
我要评论
0
18
关闭 站长推荐上一条 /2 下一条