阿里巴巴java开发规范：( 八) ) 注释规约

【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用
// xxx 方式。
说明：在 IDE 编辑窗口中， Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
建议
```
/**
* 获取用户信息
* @param  userId [用户id，对应数据库中的userid字段]
* @return    [返回单个用户或空]
*/
public User getUser(int userId )
{
 //TODO：数据访问层返回id=userId的用户信息
}
```
不建议
```
//获取用户信息
public User getUser(int userId )
{
}
```
【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
```
/**
* [获取用户信息]
* @param  userId [用户id，对应数据库中的userid字段]
* @return        [返回单个用户或空]
* @throws SQLException [举例说明而已，具体代码中要用具体的异常类，如IOException之类的]
*/
public abstract User getUser(int userId) throws SQLException{
}
```
延伸阅读：java异常设计
Java 异常设计最佳实践
如何优雅的设计Java异常？

【强制】所有的类都必须添加创建者和创建日期。

/**
* @Author finersoft
* @date 2008-08-08
*/
public class User{
}

【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释
使用/ /注释，注意与代码对齐。

/**
* [保存用户：保存至数据库中，并同步更新到缓存中]
* @param user [新用户信息：管理员新建用户，用户自主注册用户]
*/
public void addUser(User user){
  //保存用户到数据库中
  dao.addUser(user);
  /*将用户放置到缓存中
     key来自于user的userId加前缀 "CK_USER_"
         (缓存键_用户,定义于CacheKey定义的常量CK_USER上)
     value就是User本身
  */
  MapCache.getInstance().put(CacheKey.CK_USER, user);                      
}

【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

/**
* 数据库类型
*/
public enum DbType
{
 /** Oracle,甲骨文数据库 */
 Oracle,
 /** Microsoft Sql Server Database,微软Sql Server数据库 */
 MsSql,
 /** MySql( my(the name of Monty's daughter ) sql),甲骨文收购的一个开源数据库 */
 MySql
}

【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持
英文原文即可。
反例：“ TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
```
/**
* 客户端错误类型
*/
public enum ClientErrorType
{    
 /** Tcp连接超时 */
 TcpTimeOut
}
```
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑
等的修改。
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，
就失去了导航的意义。
```
对于添加了多个参数的做法：
 eclipse中可以重新生成一个注释  
 手动把之前的注释的结尾部分和现在的注释的开头部分删掉，并完善注释。
注：有返回值等说明先拷返回值。
```

【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
说明：代码被注释掉有两种可能性：1 ）后续会恢复此段代码逻辑。2 ）永久不用。前者如果没
有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。

如果是前者，必须使用多行注释来注释代码，并把来龙去脉写清楚。
方便以后重构代码或bug修正（有时候改其他同事的代码，没深入了解其做法而轻易修改时，很容易改出bug）。

10个最“优秀”的代码注释

// 亲爱的维护者：
// 如果你尝试了对这段程序进行‘优化’，
// 并认识到这种企图是大错特错，请增加
// 下面这个计数器的个数，用来对后来人进行警告：
// 浪费在这里的总时间 = 39h

【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含
义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同
天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看
的，使其能够快速接替自己的工作。

【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的
一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。
反例：方法名 put ，加上两个有意义的变量名 elephant 和 fridge ，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。

// put elephant into fridge
put(elephant, fridge);

正例：

/**
* [把大象放到冰箱 ]
* @param elephant [大象]
* @param fridge   [冰箱]
*/
public void put(Elephant elephant,Fridge fridge){
try{ 
    openFridgeDoor();   
    putElephantIntoFridge();  
    closeFridgeDoor();
}
catch(FridgeIsFullException exFull)
{
    System.out.pintln("冰箱太满了");
}
catch (ElephantIsTooFatException exFat)
{
    System.out.pintln("大象太肥了");
}
}
public static void main(String[] args) {
Elephant elephant=new Elephant("比较瘦的大象，可以放冰箱");
Fridge fridge= new Fridge("比较大而且空的冰箱，可以冰大象");
put(elephant,fridge);
}

【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，
经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1 ）待办事宜（TODO） : （标记人，标记时间， [ 预计处理时间 ]）
表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc
还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。
2 ）错误，不能工作（FIXME） : （标记人，标记时间， [ 预计处理时间 ]）
在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

/**
* @Author finersoft
* @date 2008-08-08
*/
public class User
{
/**
 * TODO:(finersoft,2008-08-08,2008-08-10)
 *     需要完成的内容：
 *         检查当前登录人是否有权限
 *         判断需要修改密码的用户的状态
 *         验证密码复杂度
 * 
 * [重设密码，由用户自行输入密码]
 * @param userId [用户Id]
 * @param newPassword [用户输入的新密码]
 */
public void resetPassword(int userId,String newPassword)
{
}
/**
 * FIXME:(finersoft,2008-08-08,2008-08-10)
 * 错误描述：
 *     之前的删除用户操作是把用户直接从数据库删除了
 *     恢复用户是直接根据userId取用户，并进行操作
 *     因为被删除的用户getUser操作的是null，所以报异常了。
 * 修改方式：
 *     判断是否为null再进行修改。
 * 关联修改：
 *     将真删，变成标记。
 *     如果用户数量庞大，则分表操作，将被删用户转移到已删除的表中
 *         并将getUser方法区别对待。
 * [恢复用户]
 * @param userId [用户Id]
 */
public void recoverUser(int userId)
{
}
}

#阿里巴巴#