有感程序编写不够规范
- 发布于:2023-09-26
- 共 131 人围观
看过斑竹及西楼还有其他的高手写的东西,读起来觉得挺费劲,一是自己的思维没达到那种层次,二是对命令函数还浮于表面,三就是非常不习惯他们对常数、变量的命名方式。呵呵,前两点只有自己加把劲了,第三点不记得是谁曾经发贴呼吁程序编写要规范,我知道是我自己的不规范习惯酿成读别人的东西那么累。因此我翻了翻互联网,找了篇关于软件代码编写规范的文章。由于太长了,所以只引用一小段,最后有个网址,有兴趣的朋友可以看看,当然如果你们有更好的文章也介绍给我啊,谢谢了。
http://www.shenyuyang.com/main/20049/2004911899.htm
《软件代码编写规范指导》
作者:不详发布时间:2004-9-11
1. 前言
凡是都有一个来龙去脉,都有一定的规则可循。编码也是一样,需要统一思想统一格式统一逻辑。
作为一个程序,程序的可维护性(可读性)是第一位的。一个难于维护的程序只不过是无谓劳动。要记住:程序是写给别人看的,不是写给计算机看的。程序的逻辑结构是第二位的。程序的逻辑结构混乱就是编程人员的思路混乱,混乱的思路不可能保证一个大型的项目能按照预想的方向发展。在一个大型的项目中,每个人的编程习惯与逻辑习惯必须保持一致。程序的格式是第三位的。良好的空格和缩进习惯将使代码易读、易改,会极大减少以后的维护工作量。程序的功能实现是第四位的。
2. 目的
人们往往希望统一规范,可是就是不指导如何统一规范,而且有了规范以后,又觉得遵循规范很是不方便,而且不同的人对规范的执行有不同的方法。我们的目的是建立一个规范,一个可以方便的去执行的规范,然后按照这个规范,一路执行下去,直到达到我们的目的。
3. 规范
3.1 命名原则
3.1.1 规则
a) 规则:常量必须为大写,如
Const MAX_PACKET_SIZE 64
Const MAX_FAILUREC_COUNT 10
b) 缩写规则:如果能用单词,就不要用缩写,如果变量名/函数名太长(大于25个字符),最好用单词首部音节代替单词。如:应使用AltExpEval代替AlternateExpressionEvaluation。
c) 大小写混合规则:用单词首部大写区分不同单词,而不应用下划线,更不应用全小写或全大写(常量除外) 。如:应使用ShortcutMenus,而不是Shortcut_Menus、Shortcutmenus、SHORTCUTMENUS、SHORTCUT_MENUS。
d) 首字/词规则:变量的首词应为三个小写字母(有g或m前缀的除外),函数名的首词必须为头一个字母大写的单词或缩写;
e) 复数规则:集合类命名应使用复数。如:类名为CAxis,其集合应命名为CAxes;类名Window,其集合名为Windows。当单词复数形式与单词完全一样时,在单词后加Collection作为其集合命名,如类名Series,集合名SeriesCollection。
f) 风格一致规则:所有变量的命名风格在项目中应一致,并需要对所有的缩写命名作说明(写入程序文档) 。当决定使用缩写而不是单词全称时必须保证在整个项目中该单词都以同样的缩写形式出现,如果频繁的在Cnt和Count之间切换会带来不必要的混淆。
g) 词序规则:过程名和函数名应以动词开头,以名词结尾,如应当使用InitNameArray,而不是NameArrayInit。类名、变量名应以名词结尾。
......