郑州软件开发-软件开发命名规范（代码注释）

三、代码注释
1.注释的目的
  a. 文字说明代码的作用 (即为什么要用编写该代码，而不是如何编写);
  b. 确指出该代码的编写思路和逻辑方法 ;
  c. 人们注意到代码中的重要转折点 ;
  d. 使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法
2.对类文件进行属性注释说明
  //=========================================
  // 模块名称：
  // 开发人员：   开发日期：
  // 功能简介：
  // 修改人员：   修改时间

// 修改人员：   修改时间：
  //=========================================
3.避免对很显然易懂的语句进行注释说明
4.代码应该能作到自我解释代码作用的功能。
5.注释来说明何时可能出错和为什么出错
6.在编写代码前进行注释，给类、属性或方法前面加上功能注释
7.注释的内容
 a.实参/ 参数
  参数类型 ， 参数用来做什么， 任何约束或前提条件
b.字段/属性
  字段描述 ， 注释所有使用的不变量， 并行事件可见性决策
 c.类
  类的目的 ，已知的问题 ， 类的开发/维护历史 ， 注释出采用的不变量 ， 并行策略
 d.接口
  目的 它应如何被使用以及如何不被使用
 e.局部变量
  用处/目的
f.成员函数注释
  成员函数做什么以及它为什么做这个
   哪些参数必须传递给一个成员函数
   成员函数返回什么
   已知的问题
   任何由某个成员函数抛出的异常
   可见性决策
   成员函数是如何改变对象的
   包含任何修改代码的历史
   如何在适当情况下调用成员函数的例子适用的前提条件和后置条件
 g.成员函数内部注释
  控制结构
   代码做了些什么以及为什么这样做
   局部变量
   难或复杂的代码
  处理顺序
8.增强注释的可读性
  a. 使用完整的语句。
  b. 避免使用缩写。
  c. 将整个单词大写，以突出它们的重要性。
9.请在每个if语句/switch语句/循环语句的前面加上注释