现在的位置: 首页 > 综合 > 正文

OA开发第一天——页面规范(一家之谈)

2013年10月22日 ⁄ 综合 ⁄ 共 695字 ⁄ 字号 评论关闭

1.把相似的内容放在一起,比如数据成员、属性、方法、事件等,并适当的使用#region…#endregion,我最喜欢把机器生成的代码都放在一个#region里面,比如在编写ASP.NET程序时,对应自动产生的控件定义,我常用#region Automatic Generated … #endregion把他们框住

 

 

2.函数、属性、类等注释请使用///三斜线注释,这种注释是基于XML的,不仅能导出XML制作帮助文档,而且在各个函数、属性、类等的使用中,编辑环境会自动带出注释,方便你的开发。以protected,protected Internal,public声明的定义注释都建议以这样命名方法。
例如:
///
/// 用于OA某某功能块///
class OAControl
{
       …
}

 

3.类库,数据定义层,MVC各层,接口s等功能模块开头,写明这些信息!

//============================================================
// Author:

// General descriptioin:
// Version:

// Create time:

// Modified people:

// Modified time:
// Detail:
//============================================================

 

 

4.函数、属性、类等注释请使用///三斜线注释,这种注释是基于XML的,不仅能导出XML制作帮助文档,而且在各个函数、属性、类等的使用中,编辑环境会自动带出注释,方便开发。

 

5.基本的缩进代码规范。

抱歉!评论已关闭.