SuperAPI AI 工具集

add-javadoc

编程与开发

查看项目

更新于 10-16 03:11

技能介绍

用途:为 Java 代码中的公共类与公共方法补充完整的 JavaDoc 文档,适合在编写 Java 代码、添加 API 文档或改进代码注释时使用。

主要能力:类级别上,为每个公共类添加说明其用途与职责的 JavaDoc,并在合适时加入 @author 标签;方法级别上,为每个公共方法添加说明其功能的 JavaDoc,为所有参数加入带清晰描述的 @param 标签,加入描述返回值的 @return 标签,并为受检异常加入 @throws 标签。

风格要求:首句应为简洁摘要;尽量少用 HTML 标签,优先使用纯文本;在相关时记录前置条件与后置条件;对复杂方法可用 {@code ...} 加入代码示例。

使用方式与限制:资料未提供具体安装命令或调用步骤,仅说明可参考 references/example.md 查看前后对比示例。未提供支持的平台、收费方式或效果保证等信息。