代码的书写规范是重重之重,保持代码书写的一致性,对进行代码的维护和交流有着很重要的地位。
由于目前我大多都是用VB进行代码的编写,下面我就主要介绍在VB中代码的命名规范。
控件命名 窗体命名
名字应该能够标识事物的特性,并且与业务挂钩。
名字一律使用英文单词,而不能为拼音。 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser
在具体任务开发中,如果有特定的命名约定,则在相应的软件开发计划中予以明确定义及上报质量管理部审计组。
命名法
Pascal命名法:所有单词的首字母都大写,其他字母小写
Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写
缩写
为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:
不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 GetWindow,而不要使用 GetWin。
不要使用计算机领域中未被普遍接受的缩写。
在适当的时候,使用众所周知的缩写替换冗长的词组名称。例如,用 UI 作为 User Interface 缩写,用 OLAP 作为 On-line Analytical Processing 的缩写。
在使用缩写时,对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。但是,应当大写仅有两个字符的缩写,如,System.IO,而不是 System.Io。
对于某些名字中单词都比较长的情况,可以自行写一个缩写名字(名字中的关键字不能缩写),将所有的缩写做一个说明文件,放在同级目录下的开头。
缩进
使用一个“Tab”为每层次缩进(默认4个空格,有的规范也要求2个空格,依要求而定
注释
代码间注释分为单行注释和多行注释