Module
jdk.javadoc
Package com.sun.javadoc
注意:此包中的声明已被包装jdk.javadoc.doclet
中的声明所取代。 有关详细信息,请参阅该软件包的文档中的“ 迁移指南” 。
Doclet由javadoc调用,并使用此API将程序信息写入文件。 例如,默认情况下调用标准doclet,并将文档写入HTML文件。
调用由抽象的Doclet
类定义 - 入门点是start
方法:
public static boolean start(RootDoc root)
RootDoc
实例保存程序结构信息的根。
从此根可以提取所有其他程序结构信息。
术语
调用javadoc时,传递包名称和源文件名称 - 这些名称称为指定的包和类。 您还传递Javadoc选项; 访问控制 Javadoc选项(-public
, -protected
, -package
,和-private
)过滤程序元件,产生一个结果集,被称为包含组,或“记录”集。
(未过滤的套件也可通过allClasses(false)
获得 。)
整个API,术语类通常为“类或接口”的简写,如: ClassDoc
, allClasses()
,和findClass(String)
。 在其他几个地方,它意味着“类,而不是接口”,如: Doc.isClass()
。 在第二个意义上说,这个API调用出来4种类: ordinary classes , enums , errors和exceptions 。 在整个API中,每个程序元素的详细描述明确地描述了正在使用的含义。
限定类或接口名称是其前缀的名称,如java.lang.String
。 非限定名称没有包名称,如String
。
例
以下是一个示例doclet,显示已处理类的@param
标记中的信息:
import com.sun.javadoc.*;
public class ListParams extends Doclet {
public static boolean start(RootDoc root) {
ClassDoc[] classes = root.classes();
for (int i = 0; i < classes.length; ++i) {
ClassDoc cd = classes[i];
printMembers(cd.constructors());
printMembers(cd.methods());
}
return true;
}
static void printMembers(ExecutableMemberDoc[] mems) {
for (int i = 0; i < mems.length; ++i) {
ParamTag[] params = mems[i].paramTags();
System.out.println(mems[i].qualifiedName());
for (int j = 0; j < params.length; ++j) {
System.out.println(" " + params[j].parameterName()
+ " - " + params[j].parameterComment());
}
}
}
}
来自Javadoc API的接口和方法标记为红色 。
Doclet
是指定用于doclet的调用接口的抽象类, Doclet
保存类或接口信息, ExecutableMemberDoc
是MethodDoc
和ConstructorDoc
的超级 接口 ,并且ParamTag
保存来自“ @param
”标签的信息。
当使用以下命令行调用此doclet时:
javadoc -doclet ListParams -sourcepath <source-location> java.util
产出如下:
...
java.util.ArrayList.add
index - index at which the specified element is to be inserted.
element - element to be inserted.
java.util.ArrayList.remove
index - the index of the element to removed.
...
-
接口摘要 接口 描述 AnnotatedType Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。AnnotationDesc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。AnnotationDesc.ElementValuePair Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。AnnotationTypeDoc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。AnnotationTypeElementDoc Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。AnnotationValue Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。ClassDoc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。ConstructorDoc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。Doc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。DocErrorReporter Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。ExecutableMemberDoc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。FieldDoc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。MemberDoc Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。MethodDoc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。PackageDoc Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。Parameter Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。ParameterizedType Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。ParamTag Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。ProgramElementDoc Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。RootDoc Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。SeeTag Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。SerialFieldTag Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。SourcePosition Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。Tag Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。ThrowsTag Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。Type Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。TypeVariable Deprecated. 该包裹中的声明已被包装jdk.javadoc.doclet
的声明所取代。WildcardType Deprecated. 该包装中的声明已被包装jdk.javadoc.doclet
的声明所取代。 -
类摘要 Class 描述 Doclet Deprecated. 该包中的声明已被包装jdk.javadoc.doclet
的声明所取代。 -
枚举摘要 Enum 描述 LanguageVersion Deprecated. The declarations in this package have been superseded by those in the packagejdk.javadoc.doclet
.