欢迎来到天天文库
浏览记录
ID:37971177
大小:94.00 KB
页数:10页
时间:2019-06-04
《c#编程规范和数据库命名规范》由会员上传分享,免费在线阅读,更多相关内容在应用文档-天天文库。
1、10编程规范代码编写1.对象的认识=模糊认识+清楚认识。当前类解决的是清楚认识部分,模糊认识由将来派生类完成。1.方法的输入、输出要有严格的定义。要做到功能明确,不越权。2.除非在万不得以的情况下,在类中不能定义公用字段,字段的引用尽量要采用属性形式。3.不可修改的字段应用Const来修饰,并说明类型。4.对你所写的每一个文件都加上相关的标准化注释,一般应包括:文件的作用、作者及时间等;例如://///////////////////////////////////////////////////////////////////////////////////////////////////
2、///////////////////////作者://时间://作用://///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////5.为你定义的类写详细的注释,包括作者、时间、修改信息、基本的算法等。类实现功能的注释方法如下://////class的摘要说明。///6.为你定义的每一个方法、字段、属性写详细的注释,包括输入输出参数说明、返回值说明、方法功能说明;如:///<
3、summary>///该方法的摘要信息//////sql参数的说明///返回值的说明publicintModifyData(stringsql){}7.写注释的时候语义要明确,注释的长度最好不要超过一句话8.所有标识符(类名、方法名、字段名、属性名等)均要求意义明确易于理解,不用关键字作为标识符,名字中避免使用易混淆的数字9.避免在代码中直接使用数字等不确定意义的词,尽量使用有意义的串值代替;如:conststaticPI=3.141592610.10尽量不用或少用goto语句,不要在
4、同一行中写多个语句,利用添加空格来清晰地表示语句的成分1.不要写太长的if(){...},for(){...},While(...){}或者太多的嵌套;对上述较长者在范围结束处加注释。如//for循环结束2.可以在程序中添加一些空格、空行和缩进等技巧,帮助人们从视觉上看清程序的结构,在使用缩进的时候应使用“Tab”键,而不是使用空格键1.在向工程中添加新页面时,.net会自动帮你生成一段代码,其中包括OnInit(Eventargse)和InitializeComponent()方法,在页面中添加事件的时候会自动在InitializeComponent()方法安装事件;但是在此过程中会出现一
5、些问题,因此不允许使用OnInit()方法,直接把这段话删除;为此,我们因在代码中添加Page_Init()方法以替代OnInit()方法,Page_Init事件可以通过页面构造函数安装,再由Page_Init调用InitializeComponent()方法2.为了便于规范,所有的页面都必需从kaiyuan.PageBase派生,而不是直接从System.Web.UI.Page派生3.在Page_Load方法开始处添加PageDatadata=CheckPage(pageID)语句,其中pageID为当前操作页面的id,具体值见PageID类命名指南总的来说除了参数(包括方法内部定义的临时
6、变量)和private作用域的字段采用Camel大小写的命名规则之外,其他的都采用Pascal大小写命名规则;如果字段是一个控件的实例,必须在后面跟上控件名;不要在字段前加g_或s_或m_等前缀;const字段一般全用大写;例如一个有关文件名的各种命名:常量:privateconststringFILE_NAME="reg.aspx";字段:privatestringfileName;字段:publicstringFileName;控件:protectedSystem.Web.UI.WebControls.TextBoxFileNameTextBox;参数:stringfileName;有关
7、具体的命名详细见以下各部分1大写样式使用下面的三种大写标识符约定1.Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如:BackColor101.Camel大小写标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:backColor2.大写标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如:Sy
此文档下载收益归作者所有