Android 修炼系列（八），2021 年 Android 开发者跳槽指南
public int test(int capacity){if (capacity < 0)throw new IllegalArgumentException("Illegal initial capacity");return capacity;}
@deprecated 用于指出一些旧特性已由改进的新特性所取代，建议用户不要再使用旧特性。常与 @link 配合，当然 @link 的使用位置没有任何限制，当我们的描述需要涉及到其他类或方法时，我们就可以使用 @link 啦，javadoc 会帮我们生成超链接：
/**
第一句话是这个方法的简短摘要。
如果这个描述太长，记得换行。
@deprecated 从 2.0 版本起不推荐使用，替换为{@link #Test2()}
@param isTest 添加参数描述，不需要刻意与其他 param
*/public void test(boolean isTest){}
@link 常见形式见下:
@code 用来标记一小段等宽字体，也可以用来标记某个类或方法，但不会生成超链接。常与 @link 配合，首次通过 @link 生成超链接，之后通过 @code 呈现等宽字体。
/**
第一句话是这个方法的简短摘要。
我们可以关联{@link Test}类，随后通过{@code Test}类怎样怎样
也可以标记一个方法{@code request()}
@param isTest 添加参数描述，不需要刻意与其他 param
*/public void test(boolean isTest){}
@see 用来引用其它类的文档，相当于超链接，javadoc 会在其生成的 HTML 文件中，将 @see 标签链到其他的文档上：
/**
第一句话是这个方法的简短摘要。
@param capacity 添加参数描述，不需要刻意与其他 param
@return 描述返回值的含义，可以多行，不需要句号结尾
@throws IllegalArgumentException 如果初始容量为负
@see com.te.Test2
@see #test(int)*/public int test(int capacity){if (capacity < 0)throw new IllegalArgumentException("Illegal initial capac
ity");return capacity;}
@see 形式与 @link 类似，见下：
@since 用来指定方法或类最早使用的版本。在标记类时，常与 @version 和 @author 配合，一个用来指定当前版本和版本的说明信息，一个用来指定编写类的作者和联系信息等。我们也可以通过< pre>来添加一段代码示例。见下：
/**
第一句话是这个类的简短摘要。
<pre>
</pre>
<p>同样可以多个段落。
@param <T> 注意当类使用泛型时，我们需要使用 params 说明。这时格式需要插入空白行
@author mjzuo 123@qq.com
@see com.te.Test2
@version 2.1
@since 2.0/public class Test<T extends Test2> {/*
第一句话是这个方法的简短摘要。
@params capacity 参数的描述
@return 返回值的描述
@since 2.1*/public int test2(int capacity) {return capacity;}}
@inheritDoc 用来从当前这个类的最直接的基类中继承相关文档到当前的文档注释中。如下的 test() 方法，会直接继承该类的直接父类的 test()方法注释。注意与其他 tag 不需要插入空行：
/**
{@inheritDoc}
@since 2.0*/public void test(boolean isTest){}
@docRoot 它总是指向文档的根目录，表示从任何生成的页面到生成的文档根目录的相对路径。例如我们可以在每个生成的文档页面都加上版权链接，假设我们的版权页面 copyright.html 在根目录下：
/**
<a href="{@docRoot}/copyright.html">Copyright</a>/public class Test {}@hide 当我们使用 google 提供的 Doclava 时，可以使用 @hide 来屏蔽我们不想暴露在 javaDoc 文档中的方法。/*
{@hide}
还未添加个人签名 2021.10.31 加入
还未添加个人简介
评论