4.9.1 注释的插入

    javadoc实用程序(utility)从下面几个特性中抽取信息:

    1)包

    2)公有类与接口

    3)公有的和受保护的方法

    4)公有的和受保护的域

    在第5章中将介绍受保护特性,在第6章将介绍接口。

    应该为上面几部分编写注释。注释应该放置在所描述特性的前面。注释以/**开始,并以*/结束。

    每个/** ... */文档注释在标记之后紧跟着自由格式文本(free-form text)。标记由@开始,如@author或@param。

    自由格式文本的第一句应该是一个概要性的句子。javadoc实用程序自动地将这些句子抽取出来形成概要页。

    在自由格式文本中,可以使用HTML修饰符,例如,用于强调的<em>...</em>、用于设置等宽“打字机”字体的<code>...</code>、用于着重强调的<strong>...</strong>以及包含图像的<img...>等。不过,一定不要使用<h1>或<hr>,因为他们会与文档的格式长生冲突。

    注释:如果文档中有到其他文件的链接,例如,图像文件(用户界面的组件的图表或图像等),就应该将这些文件放到子目录doc-files中。javadoc实用程序将从源目录拷贝这些目录及其中的文件到文档目录中。在链接中需要使用doc-files目录,例如:<img src=\'#\'" /uml.png" alt="UML diagram">。

你可能感兴趣的:(Java核心技术I)