Android修炼系列（八），你真的会写注释吗？

@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标签链到其他的文档上：

/**

• 第一句话是这个方法的简短摘要。
• </