2017-02-14 00:00:00 +0000   |     java effective java code style api   |   Viewed times   |    

使用JavaDoc

API

API包括所有public或者protected访问权限的:

  1. 接口
  2. 构造器
  3. 方法

良好的文档应该包括

  1. 做了什么
  2. 前置条件:throws未受检异常,对应的是前置条件违例。
  3. 后置条件:方法完成后,哪些条件必须满足。
  4. 副作用:比如,在后台开了什么新线程。
  5. 线程安全
  6. @param
  7. @return
  8. @throws

另外注意,{@code ...}标签,表示其中内容讲义代码字体显示,而且避免受到HTML转意元字符的影响。{@literal ...}标签只提供屏蔽HTML转意字符干扰,不以代码字体显示。