代码重构~代码注释

返回目录

一个好的程序,一个可读性强的程序,一定少不了一个好的注释!一个优秀的团队,一个高效的团队,也离不开一个规范性的代码注释。

代码注释 — 尽量将代码注释写的清楚,完整,注明代码的功能,创建者,修改者,时间等,一个好的注释,可以为程序开发人员节省很多开发的时间,当前这不是严格规定的,每个公司都有自己的标准,我们没有办法统一,只能说,将代码实现的功能写清楚即可.

代码如下:

 1        #region 代码注释
 2         /// <summary>
 3         /// 数据操作基类
 4         /// </summary>
 5         /// <remarks>
 6         /// Created By :张占岭  
 7         /// Created Date:2012-1-1
 8         /// Modify By:
 9         /// Modify Date:
10         /// Modify Reason:
11         /// </remarks>
12         class RepositoryBase
13         {
14          //...
15         }
16         #endregion

 

 返回目录

posted @ 2012-08-30 15:34  张占岭  阅读(2059)  评论(2编辑  收藏  举报