现在的位置: 首页 > 综合 > 正文

编程命名

2013年09月21日 ⁄ 综合 ⁄ 共 1338字 ⁄ 字号 评论关闭

编程命名规则

原文地址 http://blog.chinaunix.net/uid-26914516-id-3375454.html


第一:变量的命令

1:为变量命名名字的时候重要考虑事项的,该名字要完全、准确地描述出该变量所表示的事物。命名的名字跟概念相似所以容易记忆
2:名字应该尽可能的特别,不应该使用类似x,x1,x3之类。。。
3:一个好的名字反应的通常是问题而不是解决方案,即express the what more
than the how;
4:调试的最适合的变量命名长度为8-20个字符之间
第二:数据类型的命令Naming Date Type Variables
1:循环数据变量的命名,如果在外部循环使用之前时应该尽量使用详细的命名而不是仅仅是命名类似x、y、z之类的简单名字。这样会对程序后期的阅读和调试产生不必要的麻烦
2:在嵌套循环中尽量使用命名详细的命名形式,这样对以后的调试和阅读又和好的辅助
第三:状态变量的命名Naming Status Variables
1:在命名状态变量时最好不要出现模数,即让人摸不着头脑的数字,如果要使用数字可以再使用之前先进行定义,这样对程序的健壮性和可读性都有好处。
第四:临时变量的命名
在命名临时变量的时候最好不要使用temp,x,y之类的简单命名,而应该使用让人容易理解的8-20字符的名字来表达他的意思,而不是给读者一个摸不着头脑的命名。
第四:布尔变量的命名,Naming Boolen Variables
通话使用found、done、processingComplete来代替true、false,同时使用积极的命名比如isfound、isdone而不是使用消极的命名notfound等来命名
第五:枚举变量的命名Naming Enumerated Types

在使用枚举类型的时候确保每个枚举成员都属于同一个组such as color_、mouth_等


第二篇:

第一:缩写的基本准则

1:使用标准的缩写

2:去掉所有的非前置元音

3:去掉虚词and、or、the等

4:使用每个单词的第一、第二或者第三个字母后截断

5:保留每个单词的第一个和最后一个字母

6:使用名字中的每一个重要单侧,最多不超过三个

7:去掉无用的后缀-ing、ed等

8:保留每个音节中最引人注意的发音

9:保留不要改变的变量的含义

10:反复使用上述技巧,知道每个变量的名字的长度缩减到8到20个字符或者达到你所用的编程语言对变量名的限制字符数
第二::在一份项目级的标准缩写文档中说明所有的缩写

通常代码缩写会带来两种常见风险

1:代码的读者可能不理解这些缩写

2:其他程序员可能会用多个缩写来带表相同的词,从而产生不必要的混乱

为了解决这样的潜在问题,可以创建一份标准缩写文档来记录项目中用到的全部办法缩写。


第三::应该避免的名字:

1:避免使用令人误解的名字或者缩写

2:避免使用具有相似含义的名字

3:避免使用具有相同含义但却有相似名字的变量

4:避免使用发音相近的名字

5:避免在名字中使用数字

6:避免在名字中拼错单词

7:避免使用英语中常常拼错的单词

8:不要仅靠大小写来区分变量名

9:避免使用多种自然语言

10:避免使用标准类型、变量和子程序名字

11:不要使用与变量含义完全无关的名字

12:避免在名字中包含易混淆的字符

抱歉!评论已关闭.