javadoc可以在哪里放置java包级信息? [英] Where to put java package-level information to use by javadoc?

问题描述

某些API文档包含程序包级别的信息.例如，java.io包含3个程序包级部分，此处 http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html

Some API docs contain information at package level. For example java.io contains 3 package-level sections here http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html

这些部分是:程序包java.io描述"，程序包规范"和相关文档".

The sections are: "Package java.io Description", "Package Specification" and "Related Documentation".

我应该将这些部分的内容放在我自己的项目中的什么位置，以便javadoc以相同的方式对其进行处理?

Where should I put these sections content in my own project so that javadoc processes it in the same way?

推荐答案

在每个程序包中创建一个名为package-info.java的文件

create a file called package-info.java in each package

在内部执行以下操作

/**
 * Javadoc
 */
package my.cool.package123;

这篇关于javadoc可以在哪里放置java包级信息?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！