用途:该技能用于确保 Java 类型配有 Javadoc 注释,并遵循文档编写最佳实践,帮助开发者统一代码文档风格。
主要能力:依据资料,它涵盖多项 Javadoc 规范:公共和受保护成员应使用 Javadoc 注释;鼓励为包私有和私有成员编写注释,尤其当其复杂或不易自解释时;注释第一句为摘要描述,需简洁概括方法功能并以句号结尾;方法参数使用 @param,其描述以小写字母开头且不以句号结尾;返回值使用 @return;异常使用 @throws 或 @exception;引用其他类型或成员使用 @see;从基类或接口继承文档使用 {@inheritDoc},除非存在重大行为变化,此时应记录差异;泛型类型或方法的类型参数使用 @param <T>;行内代码使用 {@code};代码块使用 <pre>{@code ... }</pre>;使用 @since 标明引入版本;使用 @version 指定成员版本;使用 @author 指定作者;使用 @deprecated 标记弃用成员并提供替代方案。
使用方式:资料未提供具体安装或调用命令,暂未提供。
适用场景:适用于需要为 Java 类型补充或审查 Javadoc 的代码维护与评审流程。
限制:资料未说明其适用平台、集成方式或收费情况,暂未提供。