C#编码规范(范本)

文档编号FileNo.bpnet-S-20100224文档名称FileName中文LocalC＃编码规范版本VersionV1.0英文EnglishCodeSpecificationforC＃密级SecretLevel内部(INSIDE)存放位置Locate作者AuthorWilliamYe海南蓝点第1页共23页PrintDate:2020-07-08C＃编码规范CodeSpecificationforC＃（仅供内部使用Onlyforinsideofbpnet）作者：叶文良(WilliamYe)日期：2010年02月24日C#编码规范－文档修改记录文档编号FileNo.bpnet-S-20100224文档名称FileName中文LocalC＃编码规范版本VersionV1.0英文EnglishCodeSpecificationforC＃密级SecretLevel内部(INSIDE)存放位置Locate作者AuthorWilliamYe海南蓝点第2页共23页PrintDate:2020-07-08CodeSpecificationforC#—RevisionHistory版本号Version日期日期RevisionDate修改理由Summary/Comment修改作者RevisionBy修改的页数RevisionPages1.02010/02/24CreatewilliamYeALL文档编号FileNo.bpnet-S-20100224文档名称FileName中文LocalC＃编码规范版本VersionV1.0英文EnglishCodeSpecificationforC＃密级SecretLevel内部(INSIDE)存放位置Locate作者AuthorWilliamYe海南蓝点第3页共23页PrintDate:2020-07-08目录一、目的...........................................................................................................................................4二、适用范围...................................................................................................................................4三、命名空间...................................................................................................................................4四、文件命名规范...........................................................................................................................5五、控件命名规范...........................................................................................................................65.1WinForm内部控件命名规范.......................................................................................75.2WebForm内部控件命名规范......................................................................................85.3C#数据组件命名规范.....................................................................................................95.4C#菜单命名规范...........................................................................................................10六、变/常量命名规范...................................................................................................................116.1变量范围前缀.................................................................................................................116.2变量类型前缀.................................................................................................................11七、方法命名规范.........................................................................................................................12八、代码注释规范.........................................................................................................................138.1代码注释约定.................................................................................................................138.2模块头部注释规范.........................................................................................................138.3方法注释规范.................................................................................................................158.4代码行注释规范.............................................................................................................178.5变量注释规范.................................................................................................................18九、其它规范.................................................................................................................................199.1编程风格.........................................................................................................................199.2资源释放.........................................................................................................................219.3错误处理：.....................................................................................................................219.4其他.................................................................................................................................23文档编号FileNo.bpnet-S-20100224文档名称FileName中文LocalC＃编码规范版本VersionV1.0英文EnglishCodeSpecificationforC＃密级SecretLevel内部(INSIDE)存放位置Locate作者AuthorWilliamYe海南蓝点第4页共23页PrintDate:2020-07-08一、目的1.使用统一编码规范的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段编码。2.好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。回目录二、适用范围1.本规范不适用于数据库开发规范，数据库开发相关规范请参考相关文档；2.本规范主要以C#为开发语言的规范，为开发部的原则性规范；3.由于本规范是为撰写程序而设计，所以适用于一切有关程序撰写的工作事项。对于具体的每个项目，可能需要对之进行裁剪和补存。补存的内容确认之后公用的内容要更新到此规范中；4.适用人员：所有开发人员及代码品管人员；5.适用产品：所有以C#编写的代码。回目录三、命名空间命名空间应使用解决方案的名称，每个项目应设置一个二级命名空间，并以项目名命名。如下图：SDP为解决方案（Solution）的名称，则SDP为顶级命名空间；SDP.BF为项目名称（Assembly），则SDP.BF项目下的命名空间为：SDP.BF.ClassName文档编号FileNo.bpnet-S-20100224文档名称FileName中文LocalC＃编码规范版本VersionV1.0英文EnglishCodeSpecificationforC＃密级SecretLevel内部(INSIDE)存放位置Locate作者AuthorWilliamYe海南蓝点第5页共23页PrintDate:2020-07-08回目录四、文件命名规范1.文件命名原则是更容易区分不同的文件类型，在文件名前增加三字符的前缀，前缀字母一律为小写例如：一个窗体文件可以增加frm前缀，frmForm1.cs所有的前缀列表请参考本小节末尾的表格!2.文件主体名必须用名词或动名词，且主体名必须是单词首字大写的方式表示例如：销货单的窗体可以命名为frmInvoice.cs，一张销货单批次作废的窗体可以命名为frmCancelInvoice.cs3.文件名必须采用在不影响原意表达时尽量采用单词缩写的形式命名，以达到文件名的简洁明了的命名目的文档编号FileNo.bpnet-S-20100224文档名称FileName中文LocalC＃编码规范版本VersionV1.0英文EnglishCodeSpecificationforC＃密级SecretLevel内部(INSIDE)存放位置Locate作者AuthorWilliam