java-docs

作成者： github

Javaタイプ、メソッド、メンバーを文書化するためのJavadocのベストプラクティス。publicおよびprotectedメンバーにはJavadocコメントが必要です。package-privateおよびprivateメンバーにも推奨され、特に複雑なコードの場合はそうです。標準タグを使用します：パラメータには@param、戻り値には@return、例外には@throws、相互参照には@see、バージョン追跡には@since。最初の文は要約説明として機能し、ピリオドで終わる必要があります。パラメータの説明は小文字で始まり、ピリオドは付けません。使用...

npx skills add https://github.com/github/awesome-copilot --skill java-docs

ZIPダウンロード GitHub

39.4k

Java Documentation (Javadoc) Best Practices

Public and protected members should be documented with Javadoc comments.
It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.
The first sentence of the Javadoc comment is the summary description. It should be a concise overview of what the method does and end with a period.
Use @param for method parameters. The description starts with a lowercase letter and does not end with a period.
Use @return for method return values.
Use @throws or @exception to document exceptions thrown by methods.
Use @see for references to other types or members.
Use {@inheritDoc} to inherit documentation from base classes or interfaces.
- Unless there is major behavior change, in which case you should document the differences.
Use @param <T> for type parameters in generic types or methods.
Use {@code} for inline code snippets.
Use <pre>{@code ... }</pre> for code blocks.
Use @since to indicate when the feature was introduced (e.g., version number).
Use @version to specify the version of the member.
Use @author to specify the author of the code.
Use @deprecated to mark a member as deprecated and provide an alternative.