物联网.NET开发编程规范.docx

.NET开发编程规范

版本和版权声明

在代码的开头，应该声明版本和版权，包括版权信息、摘要、作者信息、修改信息、完成日期等。

注释

为保证程序的可读性及可维护性，应该对代码进行适当的注释，注释应该准确、易懂，同时注释是代码的提示，是代码的辅助，因此不可花言巧语、喧宾夺主。

C#的3种注释符

单行注释//用来对临时变量或属性进行注释

多行注释/*用来对代码块进行注释*/

文档注释///多用来注释类或者方法///

命名规范

帕斯卡命名法（Pascal风格）

当变量名由二个或二个以上单词连结在一起，每个单词首字母大写，其余字母小写。

骆驼式命名法（Camel-Case风格）

当变量名由二个或二个以上单词连结在一起，第一个单词首字母小写，其他单词首字母大写，其余字母小写。

在.NET代码编写中，命名空间，类，函数，接口，属性，事件，枚举等名称的命名，使用Pascal风格，参数与变量的命名使用Camel风格。

变量在命名时应做到见名思义，通过变量名能帮助对程序代码的理解，提高程序的可读性，因此变量命名一般以英文单词或汉语拼音描述。

方法的命名：一般命名为动宾短语，一个方法只完成一个任务，不要把多个任务组合到一个方法中。

缩进与空行

为保证程序代码的层次关系，作为内层代码应该缩进，如类体、方法体、代码块内的代码都应该采取缩进，在缩进的同时，应该使用代码块外对应的左右花括号独占一行并且左对齐。

{}之内的代码块左对齐。

空行起着分隔程序段落的作用。空行使程序的布局更加清晰。在每个类声明之后、每个函数定义结束之后都要加空行。在定义的方法体内，逻辑上密切相关的语句之间不加空行，其它地方应加空行分隔。

代码行

一行代码只做一件事，如变量定义，这样可增加程序易读性，并且便于注释。

if、for、while、do等语句独占一行，语句体另外起行。不论语句体有多少语句都要加{}，即使只有一条语句。这样既可防止书写错误，又便于后期维护。

大文件与长行多行

大文件：避免使用大文件，如果一个文件里的代码超过300行，应考虑将代码分开到不同的类中。

长行：代码行最大长度应控制在70至80个字符以内。

多行：避免一个方法代码行数太多，如果超过30行，应考虑将方法进行分解成多个方法。

控件命名

在.NET开发中，控件名称的命名使用骆驼式命名法进行命名，一般以控件的缩写为前缀。

常见控件名称缩写对应表

控件名称

开头缩写

控件名称

开头缩写

TextBox

txt

Button

btn

Label

lbl

ImageButton

Ib

CheckBox

chb

CheckBoxList

cbl

RadioBoxList

rb

RadioButton

rbtn

Panel

pnl

ComboBox

cbox或cb