技术开发 频道

程序开发者不可不知的C#.NET编码规范!

  三、 注释规范

  1) 在文件的头部标明文件的作者,完成时间,它所完成的主要功能。

  2) 程序有过改动后,要写上修改人、时间、简单原因说明列表。

  如:

  /********************************************************************

  * 谁创建的 日期 什么功能描述

  * 谁修改的 日期 什么功能描述

  * 谁修添加 日期 什么功能描述

  * 谁修删除 日期 什么功能描述

  ********************************************************************/

  3) 函数等代码中的注释规范都按系统自动的注释格式

  4) 修改代码时,总是使代码周围的注释保持最新。

  5) 在每个例程的开始,提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍。

  6) 避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释在公共制表位处对齐。

  7) 避免杂乱的注释,如一整行星号。

  8) 在部署之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。

  9) 如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。

  10) 在编写注释时使用完整的句子。注释应该阐明代码,而不应该增加多义性。

  11) 在编写代码时就注释,因为以后很可能没有时间这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。

  12) 避免多余的或不适当的注释,如幽默的不主要的备注。

  13) 使用注释来解释代码的意图。它们不应作为代码的联机翻译。

  14) 注释代码中不十分明显的任何内容。

  15) 为了防止问题反复出现,对错误修复和解决方法代码总是使用注释,尤其是在团队环境中。

  16) 对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。

  17) 在整个应用程序中,使用具有一致的标点和结构的统一样式来构造注释。

  18) 用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时,这样做会使注释很明显且容易被找到。

  19) 为了防止在阅读代码时左右滚动源代码编辑器,每行代码或注释不得超过一个显示屏。

  20) 可能多的注释变量表示的意思。

  四、 其它代码风格/习惯

  1) JS和CSS文件必需是UTF-8编码的文件。

  2) 单行的判断代码不需要加“{}”。

  如:if (_url.Trim().Equals(String.Empty)) return -2;

  能简写的代码要简写。保证自己写出来的代码每一句都是有效代码。

  3) 不要使用VS的自动排版代码功能。

  4) 少用“==”运算。应该使用“.Equals”进行比较。

  5) 运算符前后要空一格。如:_TotalPage = _TotalRecord / _PageSize; 这样做是不会改变代码意图的,却可以使代码更加容易阅读。

  6) 每一个操作结束后加一个空行。所有代码里不能有连续的二个或二个以上的空行。

  7) 将大的复杂代码节分为较小的、易于理解的模块。

  8) 近可能的使用TAB键来空位。不要使用4个空格来代替TAB键。

  9) 在页面文件中不能定义static类型的来传递数据。

0
相关文章