Java包装文件
示例
可以使用名为的文件在Javadocs中创建包级文档package-info.java。该文件的格式必须如下。前导空格和星号可选,通常出于格式化原因而出现在每行中
/**
* Package documentation goes here; any documentation before the first period will
* be used as a summary.
*
* It is common practice to leave a blank line between the summary and the rest
* of the documentation; use this space to describe the package in as much detail
* as is appropriate.
*
* Inline tags such as {@code code here}, {@link reference.to.other.Documentation},
* and {@literal text here} can be used in this documentation.
*/
package com.example.foo;
//文件的其余部分必须为空。在上述情况下,您必须将此文件package-info.java放入Java包的文件夹中com.example.foo。