在Eclipse中设置自动生成注释

对于开发的朋友来说，每次写类文件前面写注释文件未免有些重复。下面我们可以利用代码模板快速创建常见的注释文件。

查看默认状态

新建类文件时，默认是不生成注释的。可以通过以下步骤进行设置：

1. 在Windows菜单栏选择“Preferences”
2. 选择“Java” - “Code Style” - “Code Templates”
3. 编辑文件为7的样式（为了方便起见，中间插入截图说明，熟悉的朋友可以直接跳到步骤7）
4. 对于中文版本，选择“窗口” - “首选项” - “Java” - “代码样式” - “代码模板” - “新的Java文件”
5. 找到“菜单栏”、“窗口” - “首选项”
6. 选择“Java” - “代码样式” - “注释” - “新生成的Java文件”
7. 直接编辑配置文件，在配置文件中添加注释代码。这部分可以自定义，参考如下：

------------------我是分割线，别复制我-----------------------------------
${filecomment}${package_declaration}/
 * @author 作者 E-mail:
 * @date 创建时间：${date} ${time}
 * @version 1.0
 * @parameter 
 * @since  
 * @return  
 */
${typecomment}${type_declaration}
------------------我是分割线，别复制我-----------------------------------

新建文件将自动生成注释

现在新建文件时，就会自动生成注释。

Javadoc简介

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

Javadoc关键词列表

以下是一些常用的Javadoc关键词：

• @author 作者名
• @date 日期
• @version 版本标识
• @parameter 参数及其意义
• @since 最早使用该方法/类/接口的JDK版本
• @return 返回值
• @throws 异常类及抛出条件
• @deprecated 引起不推荐使用的警告
• @see reference 查看引用
• @override 重写

更多Javadoc的用法可以参考百度百科或官方文档。

结语

感谢你的阅读，希望这篇文章对你有所帮助。后续我会继续分享类注释、字段注释和方法注释的相关内容。

版权声明：本文内容由互联网用户自发贡献，本站不承担相关法律责任.如有侵权/违法内容,本站将立刻删除。