SKILL.md
readonly只读
name
java-docs
description
确保 Java 类型使用 Javadoc 注释进行文档化，并遵循最佳文档实践。
Java 文档（Javadoc）最佳实践
- 公共和受保护成员应使用 Javadoc 注释进行文档化。
- 鼓励对包私有和私有成员也进行文档化，特别是当它们复杂或不易自解释时。
- Javadoc 注释的第一句是摘要描述。它应简洁概述方法的功能，并以句号结尾。
- 使用
@param描述方法参数。描述以小写字母开头，不以句号结尾。 - 使用
@return描述方法返回值。 - 使用
@throws或@exception记录方法抛出的异常。 - 使用
@see引用其他类型或成员。 - 使用
{@inheritDoc}从基类或接口继承文档。- 除非有重大行为变化，此时应记录差异。
- 使用
@param <T>描述泛型类型或方法中的类型参数。 - 使用
{@code}表示内联代码片段。 - 使用
<pre>{@code ... }</pre>表示代码块。 - 使用
@since指示功能引入的时间（例如版本号）。 - 使用
@version指定成员的版本。 - 使用
@author指定代码的作者。 - 使用
@deprecated标记成员为已弃用，并提供替代方案。
