如何在 Java 中记录包? [英] How Do I Document Packages in Java?

问题描述

在 Java API 中，我可以看到包的 Javadoc 注释.

如何/在哪里放置 Javadoc 注释来记录包?

解决方案

从 1.5 开始，您可以定义 package-info.java 文件并为包提供标准的 javadoc 样式注释:

com/foo/package-info.java:

/*** com.foo 是一组用于操作 foo 事物的 bar 实用程序.*/包 com.foo;//文件的其余部分为空

包的语言规范

In the Java APIs I can see Javadoc comments for packages.

How/where do I place Javadoc comments to document a package?

解决方案

As of 1.5 you can define a package-info.java file and provide a standard javadoc style comment for a package:

com/foo/package-info.java:

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

Language specification for packages

这篇关于如何在 Java 中记录包?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！