SuperAPI AI 工具集

yard-documentation

编程与开发

查看项目

更新于 10-15 22:17

技能介绍

用途:为 Ruby 类与公开方法编写、审查 YARD 内联文档,使接口契约清晰,并便于工具生成 API 文档。核心原则是每个公开类和公开方法都要有 YARD 文档,所有文档内容(描述、注释中的示例)必须使用英文。

主要能力:类级别写一行摘要,版本重要时可用 @since;公开方法使用 @param、hash 参数用 @option、@return、必要时用 @raise,非显而易见用法用 @example。私有方法仅在行为不直观时记录,标签规则相同。

使用方式:在任何新增或修改公开 Ruby API(类、模块、公开方法)的功能或修复后,需在认为工作完成前为这些接口添加或更新 YARD;生成的任务清单中必须包含实现后的 YARD 子任务。即若只写了测试和代码,应先停下来补文档再提 PR。除用户明确要求外,不得使用其他语言生成文档。

适用场景:服务对象、API 客户端层、引擎公开 API 与扩展点,以及代码审查时确认公开接口已记录文档。

限制:资料未提供安装命令、版本、价格或具体工具集成方式;要求英文文档为主要约束,缺失事实暂未提供。