ataqq即时通讯系统编码规范new

《ataqq即时通讯系统编码规范new》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、ATAQQ即时通讯系统编码规范Version1.011目录1.规范目标32．具体注意事项32.1、命名原则32.2、变量的命名32.3、函数的命名32.4、类命名32.5、控件命名规则42.6、文件命名42.7、参数的命名53.代码格式书写规范53.1、代码书写格式53.2、注释的写法63.3、其他74.代码组织75.调试技巧85.1编译时的错误85.2运行时的错误85.3C#常见问题8附录9111.规范目标（1）安全代码完成所需的功能之余，还要增加开发过程代码的强壮性，即要稳定可靠。（2）易读类，实例，成员变量，成员函数的命名一目了然（3）美观尽量统一项

2、目组内人员的编程风格，保证一致性，统一性。2．具体注意事项2.1、命名原则(1)所有的函数(变量/类/文件名)应该代表其实际的作用。应该使用具有意义的单词或多个词组合，但不要使用人名，项目组名。(2)所有的函数(变量/类名)一律使用英文。(3)使用多个单词时不需要使用连线(如下划线)(4)多个词组合较长时，可以使用单词的缩写。(5)不得使用非常相近的名字类表示几个不同含义的函数(变量/类)。(6)命名时请考虑名字的唯一性和含义的准确性。(7)命名采用三种格式，Pascal(大小写)，Camel(大小写混合)，首字母全部大写格式如:Id2.2、变量的命名(1

3、)变量名一般由"前缀+类型修饰+代表变量含意的英文单词或单词缩写"等部分组成。如:*前缀(以下划线分割):t_:表示线程的全局变量。如:t_nCountm_:表示类成员变量(包含类表态变量)如:m_dwFlags_局部变量以”_”开头，如_userName*主体使用一个或多个单词表示变量代表的确切含义，参见下面的大小写规则。*类型修饰(小写字母):nlsufbbychszstrdouintlongshortuintfloatboolbytecharchar[]Stringdouble(2)针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，

4、统一命名为e;2.3、函数的命名(1)使用动宾词组表达函数所做的事。命名采用Pascal形式如：ShowUserInfo()，BoundGridView()等(2)同名的函数(重载函数)在功能上应该完全相同，在参数上的差别也应一目了然。(3)不得出现名字非常相近但功能不赋的函数。如:CreatePage1()，CreatePage2()等。2.4、类命名(1)名字应该能够标识事物的特性。如PublicclassEmployee()(2)名字尽量不使用缩写，除非它是众所周知的。(3)名字可以有两个或三个以上单词组成，但通常不应多于三个。(4)在名字中，所有单

5、词第一个字母都大写。缩写都要大写。11(5)不要使用下划线连接符(_)。如：publicclasssEmployeeComputeSalary即采用Pascal大小写形式。2.5、控件命名规则控件类型控件缩写标准命名举例LabellbllblMessageLinkLabellnklbllnklblTodayButtonbtnbtnSaveTextBoxtxttxtNameMainMenummnummnuFileCheckBoxchkchkStockRadioButtonrbtnrbtnSelectedGroupBoxgbxgbxMainPictureBox

6、picpicImagePanelpnlpnlBodyDataGriddgdgViewListBoxlstlstProductsCheckedListBoxclstclstCheckedComboBoxcmbcmbMenuListViewlvwlvwBrowserTreeViewtvtvwTypeTabControltctltctlSelectedDateTimePickerdtpdtpStartDateHscrollBarhsbhsbImageVscrollBarvsbvsbImageTimerTmrtmrCountImageListimglstilstI

7、mageToolBartlbtlbManageStatusBarstbstbFootPrintOpenFileDialogodlgodlgFileSaveFileDialogsdlgsdlgSaveFoldBrowserDialogfbdlgfgdlgBrowserFontDialogfdlgfdlgFootColorDialogcdlgcdlgColorPrintDialogpdlgpdlgPrint2.6、文件命名(1)文件命名要具有实际意义。(2)源文件应尽量使用命名规范，文件名只能包含字母，数字和下划线，不得使用其他的字母，超长的文件名应使用缩写方

8、式减少文件名的长度，建议使用如下的缩写的规则（部分情况可以历例外，