SuperAPI AI 工具集

java-docs

编程与开发

查看项目

更新于 10-16 09:32

技能介绍

用途:确保 Java 类型带有 Javadoc 注释,并遵循文档编写最佳实践。

主要能力与约定:公共(public)与受保护(protected)成员应写 Javadoc 注释;也鼓励为包私有与私有成员编写,尤其是复杂或不言自明者。注释首句为摘要描述,需简洁概述方法功能并以句号结尾。方法参数使用 @param,其描述以小写字母开头且不以句号结尾;返回值使用 @return;抛出的异常使用 @throws 或 @exception;引用其他类型或成员使用 @see;继承基类或接口文档使用 {@inheritDoc},除非行为有重大变化,此时应记录差异。泛型类型或方法的类型参数使用 @param <T>;行内代码片段使用 {@code};代码块使用 <pre>{@code ... }</pre>;用 @since 标明引入版本,用 @version 指定成员版本,用 @author 标明作者,用 @deprecated 标记已弃用成员并提供替代方案。

适用场景:Java 项目的 API 文档编写与代码审查。

限制:资料未提供安装命令、使用步骤、收费或平台信息。