C#项目命名规范范例

《C#项目命名规范范例》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、C#项目开发代码规范命名规范制定意义  1方便代码的交流和维护，便于日后自己的再次阅读。  2不影响编码的效率，不与大众习惯冲突。  3使代码更美观、阅读更方便。  4使代码的逻辑更清晰、更易于理解命名规范制定原则首要原则有意义的，描述性的词语来命名。能够一眼看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了1. 除约定俗成的，别用缩写。用name,address,salary等代替nam,addr,sal2. 除用于循环，别使用单个字母的变量象i,n,x等.而要使用index,temp等。for(inti=0;i<

2、count;i++){...}其他习惯l除了界面控件外，不要使用类型前缀。比如：使用名称amount，而不是intAmount；l 类：使用名词、名词短语命名。比如：publicclassFileStream；l 方法：使用动词、动词短语开始。比如：CreateUser(),RemoveAt()等；l 接口：以I开始，后面加上名词、名词短语、形容词命名。比如：IDisposable；l常量：所有单词大写，多个单词之间用"_"隔开。publicconststringPAGE_TITLE="Welcome";l 命名空间：基本格式：CompanyName/

3、ProjectName.TechnologyName[.Feature][.Design]a)CompanyName/ProjectName：公司名、项目名称或产品名称；b) TechnologyName：稳定的、公认的技术名称或架构层次名称；c) [.Feature][.Design]：可选的功能与设计；变量方法命名规则C#命名规范1、用pascal规则来命名方法和类.(第一个单词首字母大写，后面连接的每个单词首字母都大写）public class DataBase ；public void GetDataTable()2、类：使用名词、名词短语命名

4、。比如：publicclassFileStream；2.用camel规则来命名局部变量和方法的参数. (第一个单词不大写，后面连接的单词首字母大写) public void AddUser(string userId, byte[] password){ string userName;}3.所有的成员变量前加前缀 _ public class Database { private string _connectionString; } 4.接口的名称加前缀 Iinterface ICompare { int compare(); }5.自定义代码属性

5、类以Attribute结尾public class OperationAttribute : Attribute 6.自定义的异常以Exception结尾 public class AppException : Exception 7.方法的命名.一般将其命名为动宾短语，“动词＋对象”. GetRecordData();GetPath();CreateFile();8.代码的缩进.要用Tab，而不要用space.9.使用带有说明性的变量名。　　（ａ）避免单字符串的变量名，使用类似于index或temp这样有意义的名字。　　（ｂ）对于public或pro

6、tected类型的变量避免使用匈牙利表示法。　　（ｃ）不要缩写单词。10.所有的类成员变量应该被声明在类的顶部，并用一个空行把它们和方法以及属性的声明区分开.11.用有意义的名字命名namespace，如：产品名、公司名. 12.建议局部变量在最接近使用它时再声明. 13.使用某个控件的值时，尽量命名局部变量. 14.把引用的系统的namespace和自定义或第三方的用一个换行把它们分开. 15.文件名要能反应类的内容，最好是和类同名，一个文件中一个类或一组关连类. 16.目录结构中要反应出namespace的层次.17.大括号"{"要新起一行 .18

7、.在和你的代码缩进处于同一个级别处为该行代码添加注释19单独方法要加注释字段（一目了然的课一部详细说名）例如： ///