ATAQQ即时通讯系统编码规范.docVIP

ATAQQ即时通讯系统编码规范 Version1.0 目录 1. 规范目标 3 2．具体注意事项 3 2.1、命名原则 3 2.2、变量的命名 3 2.3、函数的命名 3 2.4、类命名 3 2.5、控件命名规则 4 2.6、文件命名 4 2.7、参数的命名 5 3. 代码格式书写规范 5 3.1、代码书写格式 5 3.2、注释的写法 6 3.3、其他 7 4. 代码组织 7 5. 调试技巧 8 5.1 编译时的错误 8 5.2 运行时的错误 8 5.3 C#常见问题 8 附录 9 1. 规范目标 （1）安全 代码完成所需的功能之余，还要增加开发过程代码的强壮性，即要稳定可靠。 （2）易读 类，实例，成员变量，成员函数的命名一目了然 （3）美观 尽量统一项目组内人员的编程风格，保证一致性，统一性。 2．具体注意事项 2.1、命名原则 (1)所有的函数(变量/类/文件名)应该代表其实际的作用。应该使用具有意义的单词或多个词组合，但不要使用人名，项目组名。 (2)所有的函数(变量/类名)一律使用英文。 (3)使用多个单词时不需要使用连线(如下划线) (4)多个词组合较长时，可以使用单词的缩写。 (5)不得使用非常相近的名字类表示几个不同含义的函数(变量/类)。 (6)命名时请考虑名字的唯一性和含义的准确性。 (7)命名采用三种格式，Pascal(大小写)，Camel(大小写混合)，首字母全部大写格式如:Id 2.2、变量的命名 (1)变量名一般由前缀+类型修饰+代表变量含意的英文单词或单词缩写等部分组成。 如: *前缀(以下划线分割): t_:表示线程的全局变量。如:t_nCount m_:表示类成员变量(包含类表态变量)如:m_dwFlags _ 局部变量以”_”开头，如 _userName *主体使用一个或多个单词表示变量代表的确切含义，参见下面的大小写规则。 *类型修饰(小写字母): n l s u f b by ch sz str dou int long short uint float bool byte char char[] String double (2)针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为 e; 2.3、函数的命名 (1)使用动宾词组表达函数所做的事。命名采用Pascal形式 如：ShowUserInfo()，BoundGridView()等 (2)同名的函数(重载函数)在功能上应该完全相同，在参数上的差别也应一目了然。 (3)不得出现名字非常相近但功能不赋的函数。如:CreatePage1()，CreatePage2()等。 2.4、类命名 (1)名字应该能够标识事物的特性。如Public class Employee() (2)名字尽量不使用缩写，除非它是众所周知的。 (3)名字可以有两个或三个以上单词组成，但通常不应多于三个。 (4)在名字中，所有单词第一个字母都大写。缩写都要大写。 (5)不要使用下划线连接符(_)。 如：public classs EmployeeComputeSalary 即采用Pascal大小写形式。 2.5、控件命名规则 控件类型 标准命名举例 Label lbl lblMessage LinkLabel llbl lnklblToday Button btn btnSave TextBox txt txtName MainMenu mmnu mmnuFile CheckBox chk chkStock RadioButton rbtn rbtnSelected GroupBox gbx gbxMain PictureBox pic picImage Panel pnl pnlBody DataGrid dg dgView ListBox lst lstProducts CheckedListBox clst clstChecked ComboBox cmb cmbMenu ListView lvw lvwBrowser TreeView tv tvwType TabControl tctl tctlSelected DateTimePicker dtp dtpStartDate HscrollBar hsb hsbImage VscrollBar vsb vsbImage Timer Tmr tmrCount ImageList imglst ilstImage ToolBar tlb tlbManage StatusBar stb stb