代码规范小结

来源:互联网 发布:windows 关键问题 编辑:程序博客网 时间:2024/06/04 18:33

          现在学习VB已经有一段时间了,对敲代码有了新的感触,一直想要整理一下。尤其是经过了作品展,感觉对代码规范的书写有了更大的体会,你敲出的东西,对他人有多少价值,敲的时候又为他人考虑了多少.这都是需要我们慢慢学习体会的.

代码规范
一.命名约定
    (虽然VB中对字母大小写不敏感,但是还是要严谨处理,当我们给变量等命名时最好还是按字母大小写敏感处理.这是一种态度,对以后学习会有帮助的.)
   1.变量命名规定,.必须以字母开头.不可以包含嵌入的句号或者类型声明字符.不能超过255个字符(控件、窗体、类和模块的名字不鞥超过40个字符)
   2.当变量名为多个单词时,一般要大小写混合写,如:maxElement(第一个词小写,之后的每一个单词都以首字母大写开头)
   3.函数名或过程名必须要大写字母开头,尽量采用组合词来表示其功能。(函数名一般为动词起首或包含其返回类型如:GetValue,IsEmpty)
二.代码布局格式约定
   1.一般语句块之间至少要空一行(不要嫌浪费地方哈,恰当的空行能使你的代码更有层次感,条理清晰!)
   2.一定要分层次,下一层要用tab键(既省事又规范,不要用使劲敲空格键哈)缩进,同一层次要对齐。
   3.一行最好只写明一件事情,其余部分用来注释(随时表明注释,为人民服务)。

三:关于注释
    原来敲代码的都是比较短的小程序,谈不上注释,觉得多余麻烦。作品展期间,加上分工完成功能,那如果不加注释的话,看别人的代码那完全不懂。现在的话,不管多么短的程序,我都是先注释,然后往下进行。(其实这样更方便自己,敲程序前给自己思路)
   1.每一个模块文件开头,都应该有一段注释,说明接下来要完成的功能。
   2.对于程序中需要的变量等要注释清楚,包括对象的声明或定义。
   3.对于废掉的代码段,就我现在来说,不要删掉的好,但是要在前面注释清楚,代码废掉的原因
   4.对于关键性代码行,最好单独注释说明。

 

Ps:1.类型:尽量用long,double而非integer和single,但是尽量不要用变体型(variant

      2.结构嵌套不超过四层,不然就要晕菜了!