Myeclipse 中的注释
注释也是一门艺术,好的注释不仅便于后期维护,还可以生成接口文档便于前端查阅。 有必要的话可以将自己的注释写成一个模板,以后用的时候直接复制就行。关于在myeclipse中如何设置注释模板,请参考:https://blog.csdn.net/u012463017/article/details/52189802文档注释中是支持html标签的 所以可以定制自己的模板。下面是我目前用注释模板：
/*
<p><b>描述：</b></p>
<p></p>
<p><b>用途：</b> </p>
<p></p>
*/
这个模板显示效果如上图，注释写完直接导出成javadoc文档留存。
虽然注释写起来比较麻烦费时，但是我相信完整的注释不仅会对项目后期有很大作用，对于后期自己维护，或者别人维护的时候都是一件有意义的事情。
当然方法内的其他注释也是不能少的。
// 这是单行注释 /****这是多行注释**/ /** *这是文档注释 */ 注释关键字： @author 作者 @param 参数 @return 返回值 @exception 异常 @see 引用其他类 @version 版本号 @since 从什么时候开始 @throws 抛出异常 @deprecated 过时 @category 种类 @serialData 说明通过writeObject()和writeExternal()方法写的数据
好记性不如烂笔头,趁着还记得住,写下备用.
声明：本站所有文章资源内容，如无特殊说明或标注，均为采集网络资源。如若本站内容侵犯了原著者的合法权益，可联系本站删除。
