vs2008c#编程规范.doc

《vs2008c#编程规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

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

2、inti=0;i

3、本格式：CompanyName/ProjectName.TechnologyName[.Feature][.Design]a)CompanyName/ProjectName：公司名、项目名称或产品名称；b) TechnologyName：稳定的、公认的技术名称或架构层次名称；c) [.Feature][.Design]：可选的功能与设计；规范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 com

5、pare(); }5.自定义代码属性类以Attribute结尾public class OperationAttribute : Attribute 6.自定义的异常以Exception结尾 public class AppException : Exception 第2页Boss3g软件开发规范7.方法的命名.一般将其命名为动宾短语，“动词＋对象”. GetRecordData();GetPath();CreateFile();8.代码的缩进.要用Tab，而不要用space.9.使用带有说明性的变量名。　　（ａ）避免单字符串的变量名，使

6、用类似于index或temp这样有意义的名字。　　（ｂ）对于public或protected类型的变量避免使用匈牙利表示法。　　（ｃ）不要缩写单词。10.所有的类成员变量应该被声明在类的顶部，并用一个空行把它们和方法以及属性的声明区分开.11.用有意义的名字命名namespace，如：产品名、公司名. 12.建议局部变量在最接近使用它时再声明. 13.使用某个控件的值时，尽量命名局部变量. 14.把引用的系统的namespace和自定义或第三方的用一个换行把它们分开. 15.文件名要能反应类的内容，最好是和类同名，一个文件中一个类或一组关

7、连类. 16.目录结构中要反应出namespace的层次.17.大括号"{"要新起一行 .18.在和你的代码缩进处于同一个级别处为该行代码添加注释控件命名控件的名称中需要加上前缀，之所以这样做是为了区分界面的控件和普通的对象，由于界面修改往往非常频繁，区分开来能使你更快速的找到控件，从而修改界面。举一个例子：界面有10个TextBox、10个Label。一个TextBox对应一个Label，为了完成读写，你至少要有20条语句来从控件进行取、赋值操作，如果有前缀的话，输入this.txt，你就几乎马上能找到这个控件。反之，如果没有前缀，由于

8、窗口或页面对象拥有大量的属性和变量（>100个），你将花费大量时间来查找。另外一个TextBox对应一个Label（一个代表值，一个代表名称），它们往往指同一样事物，如果有前缀，就很容易区分这