关于 java-docs
java-docs 是 Java 文档编写规范技能，面向需要为 Java 成员编写 Javadoc 的开发者。它涵盖注释结构、标签和代码格式等规则。
主要功能
- 01公共与受保护成员文档规范
- 02Javadoc 标签使用指南
- 03内联代码格式建议
- 04继承与弃用文档指引
适用场景
- 01为方法和成员补充 Javadoc
- 02记录参数、返回值与异常
- 03维护泛型和继承 API 文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/java-docs确认已加载。
详细介绍
Java 文档（Javadoc）最佳实践
- 公共成员和受保护成员应使用 Javadoc 注释编写文档。
- 鼓励也为包级私有成员和私有成员编写文档，尤其是当它们较为复杂或并非一目了然时。
- Javadoc 注释的第一句话是摘要描述。它应简洁概述该方法的作用，并以句号结尾。
- 使用
@param标注方法参数。描述以小写字母开头，且不以句号结尾。 - 使用
@return标注方法返回值。 - 使用
@throws或@exception标注方法抛出的异常。 - 使用
@see引用其他类型或成员。 - 使用
{@inheritDoc}从基类或接口继承文档。- 除非存在重大行为变化，在这种情况下应记录这些差异。
- 使用
@param <T>标注泛型类型或方法中的类型参数。 - 使用
{@code}标注行内代码片段。 - 使用
<pre>{@code ... }</pre>标注代码块。 - 使用
@since指明该特性的引入时间（例如版本号）。 - 使用
@version指定该成员的版本。 - 使用
@author指定代码的作者。 - 使用
@deprecated将成员标记为已弃用，并提供替代方案。
评论
支持 Markdown