本篇文章主要介绍了" Java IDE中设置作者日期等Javadoc注释信息",主要涉及到方面的内容,对于Javajrs看球网直播吧_低调看直播体育app软件下载_低调看体育直播感兴趣的同学可以参考一下:
在Java的IDE(IntegratedDevelopment Environment,集成开发环境)中,如Eclipse、Spring Tool Suite、...
在Java的IDE(Integrated
Development Environment,集成开发环境)中,如Eclipse、Spring Tool Suite、IntelliJ IDEA等,都可以设置自动添加的Javadoc注释信息,可以添加@author
作者名、@version 版本标识、@date 日期等,新添加类或方法时会自动添加注释信息,很方便。/**被注释语句*/ 就是专为Javadoc设计,可以被JDK内置的Javadoc工具支持和处理,下面就介绍下如何设置Javadoc注释信息和注释的规范。
1、先来了解下Javadoc
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
关键词列表:
- @author 作者名
- @date 日期
- @version 版本标识
- @parameter 参数及其意义
- @since 最早使用该方法/类/接口的JDK版本
- @return 返回值
- @throws 异常类及抛出条件
- @deprecated 引起不推荐使用的警告
- @see reference 查看引用
- @override 重写
更多Javadoc用法可以访问:百度百科、官方文档。
2、自动添加Javadoc注释信息
以Spring Tool Suite为例,其他IDE大致相同。

点击菜单中的Window 》Preferences 》Java 》Code Style 》Code Templates,对右侧Comments选项中具体的注释信息进行编辑设置即可。最下面可以勾选上自动添加注释信息,也可以手动插入注释,在类内部或者方法内部,点击菜单中 Source 》 Generate Element Comment,或者使用快捷键 Shift+Alt+J。
3、Javadoc注释的规范
附上Javadoc注释的规范,这才是本文的重点,${}的是变量,IDE会自动添加,当然也可以直接改为固定文字。
注释的规范如下:
1、文件注释标签:
/**
*
Title: ${file_name}
*
Description:
*
Copyright: Copyright (c) 2013
*
Company: www.izhangheng.com
* @author zhangheng
* @date ${date}
* @version 1.0
*/
2、类型注释标签(类的注释):
/**
*
Title: ${type_name}
*
Description:
*
Company: www.izhangheng.com
* @author zhangheng
* @date ${date}
*/
3、字段注释标签:
/** ${field}*/
4、构造函数标签:
/**
*
Title:
*
Description:
* ${tags}
*/
5、方法标签: