使用JavaJDK中的javadoc进行文档注释

注释的插入

javadoc从以下几个特性中抽取信息：

• 包
• 公有类和接口
• 公有的和受保护的构造器和方法
• 公有的和受保护的域
  注释应放在所描述特性的前面，以/*开始， /结束，之后紧跟着自由格式文本，标记由@开始。
  自由格式文本的第一句应该是一个概要性的句子，文本中可以使用HTML修饰符，若要键入等宽代码，须使用{@code…}

类注释

必须放在import语之后，类定义之前

方法注释

• @param 变量描述
  对当前方法的参数添加一个条目
• @return 描述
  对当前方法添加返回部分
• @throws 类描述
  添加一个用于表示这个方法可能抛出的异常的注释

域注释

只需要对公有域（通常是指静态常量）建立文档

通用注释

• @author 姓名
• @version 文本
• @since 文本
  可以是对引入特性的版本描述
• @deprecated 文本
• @see 引用
  • 提供类、方法或变量的名字，javadoc就会在文档中插入一个超链接
    需要注意，一定要使用#来分隔类名与方法名，或类名和变量名
  • @see后面有一个<字符，就需要指定一个超链接
  • @