Eclipse中设置注释、日期等信息
阅读原文时间:2024年09月04日阅读:1

在使用Eclipse 编写Java代码时,自动生成的注释信息都是按照预先设置好的格式生成的,例如其中author,datetime等属性值。

我们可以在Eclipse 中进行设置自己希望显示的注释信息。

操作如下:点击Windows->Preferences->Java->Code Style->Code Templates, 在右边有个的comments选项, 我们就可以在里面编辑相关的注释信息。

例如我们希望在一个Java文件的开头设置作者作者信息以及日期信息。

选择Types,点击Edit,将

/**
  * @author ${user}
* ${tags}
*/

将${user}替换为vkzhang,这样作者信息就变成vkzhang;点击Insert Variable,选择Date,这样就会自动生成日期信息。

设置完以后我们测试一下,自动生成的注释信息为:

/**
* @author vkzhang

* 2015-2-2
*/

同样,在comments下还有Files,Methods,delegate methods等属性,可以供我们一一设置,具体注释的规范如下:

文件注释标签:

/**
*

Title: ${file_name}


*

Description:


*

Copyright: Copyright (c) 2007


*

Company: LTGames


* @author vkzhang
* @date ${date}
* @version 1.0
*/

类型注释标签(类的注释):

/**
*

Title: ${type_name}


*

Description:


*

Company: LTGames


* @author    vkzhang
* @date       ${date}
*/

字段注释标签:

/** ${field}*/

构造函数标签:

/**
*

Title:


*

Description:


* ${tags}
*/

方法标签:

/**
*

Title: ${enclosing_method}


*

Description:


* ${tags}
*/

覆盖方法标签:

/* (非 Javadoc)
*

Title: ${enclosing_method}


*

Description:


* ${tags}
* ${see_to_overridden}
*/

代表方法标签:

/**
* ${tags}
* ${see_to_target}
*/

getter方法标签:

/**
* @return ${bare_field_name}
*/

setter方法标签:

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

当我们要在某个位置添加注释时,点击菜单栏 中【源代码】下的【添加 Javadoc 注释】,或者使用快捷键 Alt+Shift+J , Eclipse 就会自动在该方法前面添加注释。

手机扫一扫

移动阅读更方便

阿里云服务器
腾讯云服务器
七牛云服务器

你可能感兴趣的文章