---
id: ssh-java-docs
name: "java-docs"
url: https://skills.yangsir.net/skill/ssh-java-docs
author: github
domain: writing
tags: ["javadoc", "java-documentation", "api-documentation", "code-comments", "technical-writing"]
install_count: 9700
rating: 4.50 (299 reviews)
github: https://github.com/github/awesome-copilot
---

# java-docs

> 确保Java类型使用Javadoc注释进行文档化，并遵循文档编写的最佳实践。

**Stats**: 9,700 installs · 4.5/5 (299 reviews)

## Before / After 对比

### 规范Java代码Javadoc文档编写

## Readme

# 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.


---
*Source: https://skills.yangsir.net/skill/ssh-java-docs*
*Markdown mirror: https://skills.yangsir.net/api/skill/ssh-java-docs/markdown*