用户登录
用户注册

分享至

eclipse注释设置

  • 作者: 优衣库库长丶
  • 来源: 51数据库
  • 2020-10-02
先看默认状态的吧,新建类文件时,是不生成注释的


windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java file

编辑文件为7的样式,(为了方便起见,中间分布截图说明,熟悉的朋友直接跳到7)
对于中文版本
窗口-->首选项
java-->代码样式-->代码模板
代码-->新的java文件
菜单栏,窗口——首选项

找到java选项-->代码样式

注释-->新生成的java文件

直接编辑配置文件
在配置文件中间添加注释代码,这部分可以自定义,参考如下,关键字解释见后文10
------------------我是分割线,别复制我-----------------------------------
${filecomment}${package_declaration}/** * @author 作者 E-mail: * @date 创建时间:${date} ${time} * @version 1.0 * @parameter * @since * @return */${typecomment}${type_declaration}
------------------我是分割线,别复制我-----------------------------------
现在新建文件将自动生成注释

补充说明;
也许你看到我们在写注释文件时用到了很多关键字,那么这里我们就了解一下Javadoc
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了
关键词列表:
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference 查看引用
@override 重写
更多Javadoc用法可以访问:百度百科、官方文档。



  window-文件(files)注释标签: /** * copyright ? ${year}公司名字. all rights reserved. * * @title: ${file_name} * @prject: ${project_name} * @package: ${package_name} * @description: ${todo} * @author: ${user} * @date: ${date} ${time} * @version: v1.0 */ 类型(types)注释标签(类的注释): /** * @classname: ${type_name} * @description: ${todo} * @author: ${user} * @date: ${date} ${time} * ${tags} */ 字段(fields)注释标签: /** * @fieldname: ${field} * @fieldtype: ${field_type} * @description: ${todo} */ 构造函数标签: /** * @title:${enclosing_type} * @description:${todo} * ${tags} */ 方法(constructor & methods)标签: /** * @title: ${enclosing_method} * @description: ${todo} * ${tags} * @return: ${return_type} */ 覆盖方法(overriding methods)标签: /* (non javadoc) * @title: ${enclosing_method} * @description: ${todo} * ${tags} * ${see_to_overridden} */ 代表方法(delegate methods)标签: /** * ${tags} * ${see_to_target} */ getter方法标签: /** * @return the ${bare_field_name} */ setter方法标签: /** * @param ${param} the ${bare_field_name} to set */ 或者可以从网上下载配置好的.xml文件导入也可以。下载请点击我! ps:在按照上面的方法设置后,一定要到windows->preferences->general->content types,右侧context types树,点开text,选择java source file,在下面的default encoding输入框中输入utf-8,点update,则设置java文件编码为utf-8,否则会出现字符编码的问题。 经过如上的设置后,就可以使用快捷键alt+shift+j来快速生成文档的注释了。使用方法如下: 文件头注释: 使用new->class方法生成的文件会在创建类的对话框选项中提示是否生成注释,默认是选中的。这样生成的.java文件就有在文件头带有上面设置的版权信息。若是使用new->file方法建立的java文件则不会自动生成文件头的版权信息,必须手动输入。 方法、类、字段等注释: 这一类的注释只需要选中方法名、类名、或字段名,然后使用alt+shift+j来自动生成注释,然后补全信息即可。 望采纳
软件
前端设计
程序设计
Java相关