天天看点

Myeclipse 中的注释

注释也是一门艺术,好的注释不仅便于后期维护,还可以生成接口文档便于前端查阅。
        有必要的话可以将自己的注释写成一个模板,以后用的时候直接复制就行。
关于在myeclipse中如何设置注释模板,请参考:https://blog.csdn.net/u012463017/article/details/52189802
文档注释中是支持html标签的 所以可以定制自己的模板。
下面是我目前用注释模板:           
  • @author
  • @param
  • @return 返回Message对象<br/>
  • <b>内容:</b><p>message: "", status: true, list: null, listSize: 0, map: null</p>
  • <p>message的内容为提示字符串</p>
  • <p>status为状态 true为真 false为假</p>
  • <p>list 为数据集合</p>
  • <p>listSize 为集合长度</p>
  • <p>map为 键值对的数据集合</p>

    */

    Myeclipse 中的注释
// 这是单行注释
    /*
*
**这是多行注释
*
*/

        /**
        *这是文档注释
        */
        注释关键字:
                        @author   作者
                        @param  参数
                        @return  返回值
                        @exception  异常
                        @see  引用其他类
                        @version  版本号
                        @since  从什么时候开始
                        @throws 抛出异常
                        @deprecated 过时
                        @category 种类
                        @serialData 说明通过writeObject()和writeExternal()方法写的数据
           

继续阅读