在Eclipse中设置自动生成注释

来源:互联网 发布:中国联合网络通信电话 编辑:程序博客网 时间:2024/06/03 09:26

对于开发的朋友,每次写类文件前面写注释文件,未免有些许重复,下面我们利用代码模板快速常见注释文件

  1. 先看默认状态的吧,新建类文件时,是不生成注释的

    在Eclipse中设置自动生成注释
  2. windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java file

    编辑文件为7的样式,(为了方便起见,中间分布截图说明,熟悉的朋友直接跳到7)

  3. 对于中文版本

    窗口-->首选项

    java-->代码样式-->代码模板

    代码-->新的java文件

  4. 菜单栏,窗口——首选项

    在Eclipse中设置自动生成注释
  5. 找到java选项-->代码样式

    在Eclipse中设置自动生成注释
  6. 注释-->新生成的java文件

    在Eclipse中设置自动生成注释
  7. 直接编辑配置文件

    在配置文件中间添加注释代码,这部分可以自定义,参考如下,关键字解释见后文10

    ------------------我是分割线,别复制我-----------------------------------

    ${filecomment}${package_declaration}/** * @author  作者 E-mail: * @date 创建时间:${date} ${time} * @version 1.0 * @parameter  * @since  * @return  */${typecomment}${type_declaration}

    ------------------我是分割线,别复制我-----------------------------------

  8. 现在新建文件将自动生成注释

    在Eclipse中设置自动生成注释
  9. 补充说明;

    也许你看到我们在写注释文件时用到了很多关键字,那么这里我们就了解一下Javadoc

    Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了

  10. 关键词列表:

    @author 作者名

    @date 日期

    @version 版本标识

    @parameter 参数及其意义

    @since 最早使用该方法/类/接口的JDK版本

    @return 返回值

    @throws 异常类及抛出条件

    @deprecated 引起不推荐使用的警告

    @see reference 查看引用

    @override 重写

    更多Javadoc用法可以访问:百度百科、官方文档。

  11. 后期会继续给大家分享类注释、字段注释、方法注释

0 0
原创粉丝点击