1. IDEA 自动生成
对于类中的注释，我们可以通过IDEA自动生成。
如IDEA 可以通过：File->Settings->Editor->File and Code Templates->Includes->File Header来设置模板，这样新建文件时，IDEA会按照设置的模板，会自动生成一个注释。
其中标签有:
${USER} : 当前用户。
${DATE} : 当前日期。
${PACKAGE_NAME}：包名。
${TIME}: 当前时间。
${YEAR}： 当前年。
${MONTH}：当前月。
${DAY}: 当前日。
${HOURS}： 当前小时。
${MINUTE}: 当前分钟
2、以下为javadoc 需要熟知的注释标签:
@see 引用类/方法。
@author: 作者。
@date：日期。
@version: 版本号。
@throws：异常信息。
@param：参数
@return： 方法返回值。
@since: 开源项目常用此标签用于创建日期 。
{@value}: 会使用该值，常用于常量。
{@link} 引用类/方法。
{@linkplain} 与@link功能一致。
3、常用标签
<p></p>: 表示一整段文字的描述，没有换行
<b></b>: 表示文字用粗黑体
{@link Class#Method}: 表示蓝色高亮显示，而且点击可以跳转到对应Class#Method
{@link #Method}: 表示蓝色高亮显示，而且点击可以跳转到当前Class 的 Method
<code></code>: 表示文字用代码的字体表示出来，没有高亮，但是字体跟普通注释不一样
{@see Class#Method}: 注释会自动添加“See Also xxxxx” 后面的Class#Method 也会高亮显示并且自动链接跳转
Note : ‘#’ 一般表示 ‘.’ ，例如 Intent.getIntExtra(String name), 用注释文字写成 Intent#getIntExtra(String name)
4、 {@link}与@see的简单使用以及区别
@see 标签允许用户引用其他类的文档。具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。
但是，{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果，看下面的图吧。
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。
文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/14013.html
