每天学点java—文档注释

  今天就总结一下JAVA中的文档注释方式，以方便以后必要的时候可以查找。
  JAVA中有一个很有用的工具javadoc，可以自动生成HTML文档。我们只需要在实际编码过程中写一些特定格式的注释就可以实现了。

1.类注释：只要在import语句后，类定义前进行注释。还有一些特殊的标记例如@author；注释中的自由文本中还可以使用一些html标记。

import java...
/**
 *  这里是类注释
 *  @author lysongzi
*/
class person
{
    ...
}

2.方式注释：写在所描述的方法前。主要的标记如下:
@param，对方法中变量的描述；
@return，对方发添加return部分的注释；
@throws，用于表示这个方法会抛出异常；
以上的每个标记都可以跨越多行，且可以使用html标记。

/**
    这个方法的功能简介
    @param pid 查询的id
    @return 返回年龄
*/
public int getAgeById(int pid)
{
    ...
}

3.域注释：主要是对公有域进行注释。
4.通用注释:
@author：作者姓名；
@version：对当前版本的描述；
@since：对某个版本后引入的特性进行描述；
@deprecated：标记类或方法不再使用，并给出取代建议；
@see：插入超链接。