1. ホーム
  2. java

[解決済み】Javaでパッケージを文書化する方法とは?

2022-04-14 15:34:59

質問

Java APIの中で、パッケージのJavadocコメントを見ることができます。

パッケージを文書化するためのJavadocコメントは、どのように/どこに配置すればよいですか?

どのように解決するのですか?

1.5以降では package-info.java ファイルを作成し、パッケージの標準的な javadoc スタイルのコメントを提供します。

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

パッケージの言語仕様