WS代码书写规范.doc

WS 代码书写规范

1. 文件结构........................................................................................................................................2

2. 命名约定........................................................................................................................................3

3. 常量，枚举，变量的使用............................................................................................................5

3.1 常量的使用...........................................................................................................................5

3.2 枚举的使用...........................................................................................................................5

3.2 变量的使用...........................................................................................................................5

4. 过程/函数的使用...........................................................................................................................7

工作站采用 vb.net（2008）开发

Vb.net 的文件格式统一使用***.vb 的后缀形式，不通过后缀名区分窗体，模块等

使用 Imports 方法导入需要的命名空间

工作站文件目录构成如下图所示

My Project：工程的各种设置

BaseForms：3 类基本画面的原型（主画面，嵌入式画面，对话框）

CpsModule：上位通讯处理

Modules：各类模块化处理

（1）De"neModule.vb：常量，枚举类型的定义

（2）FileModule.vb：文件读写处理

（3）FtpModule.vb：FTP 上传下载处理

（4）FunctionModule.vb：共通函数处理

未完待续…

Resources：工程的各种资源文件

（0）命名内容用单词的首字母大写作为区分

（1）常量名：C_开头

（2）尽量给同一使用范畴的常量起相同的命名头部

例：

UnixStyle = 1

WindowsStyle = 2

End Enum

（5）全局变量名：g_ 开头

（6）模块变量名：m_ 开头

（7）局部变量名：

① 第一个单词用小写字母开头

② 本地循环用的计数变量，一般使用 i, j, k

③ 使用缩写

（8）参数名：与局部变量的命名规则相同

（11）命名的对称性: 注意命名的对称性

　　例： add/remove

　　例： insert/delete

　　例： get/set

　　例： start/stop

　　例： begin/end

　　例： send/receive

　　例： "rst/last

　　例： up/down

　　例： show/hide

　　例： lock/unlock

　　例： old/new

　　例： next/previous