4.9 文档注释

来源：互联网发布：php魔术常量编辑：程序博客网时间：2024/06/04 18:30

JDK包含一个很有用的命令javadoc，可以把你写的文档注释提取出来成为一个HTML文档。
注意：是‘/**’开始
‘*/’结束的注释。

1 注释的插入

javadoc工具会从以下几项中抽取信息。

包
public类和接口
public和protected属性
public和protected构造器和方法

2 类注释

类注释是导入语句之后类声明之前的的注释。

/*** A {@code Card} object represents a playing card, such* as "Queen of Hearts". A card has a suit (Diamond, Heart,* Spade or Club) and a value (1 = Ace, 2 . . . 10, 11 = Jack,* 12 = Queen, 13 = King)*/public class Card{    ...}

3 方法注释

方法注释是在方法之前的注释，你可以使用如下关键词表示特定含义：

@param 变量描述
@return 返回描述
@throws 抛出异常描述

/*** Raises the salary of an employee.* @param byPercent the percentage by which to raise the salary (e.g. 10 means 10%)* @return the amount of the raise*/public double raiseSalary(double byPercent){    double raise = salary * byPercent / 100;    salary += raise;    return raise;}

4 属性注释

/** The "Hearts" card suit*/public static final int HEARTS = 1;

5 通用注释

你可以在注释中加入如下一些语句：

@author 作者 //通常在类注释中
@version 版本 //通常在类注释中
@since 版本
@deprecated 不推荐使用说明以及建议
@see 参考
｛@link package.class#feature label｝超链接

6 包和注释概述

7 抽取注释

javadoc -d docDirectory *.java

0 0