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.