`
javawebsoa
  • 浏览: 409786 次
社区版块
存档分类
最新评论

Java学习笔记:(39)为所有导出的API元素编写文档注释

 
阅读更多
需要增加注释的地方:类、接口、构造函数、方法和域声明,

方法注释的内容:

调用该方法的前提条件;
调用后的后续处理(如捕获异常);
副作用(如方法启动线程后带来的安全性);
参数@param Describe;
返回@return Describe;
异常@throws if.....;

注意:注释中可以适用<p><code><tt>等HTML标签,但>,<等标签需要转义。


分享到:
评论

相关推荐

Global site tag (gtag.js) - Google Analytics