用途:在撰写 Ruby 类与公开方法的 YARD 文档时使用,确保公开接口契约清晰、可生成 API 文档。核心原则是每个公开类和公开方法都有 YARD 文档。
主要能力与规则:类需一行摘要,版本重要时可加 @since;公开方法必须包含 @param、@option(用于哈希参数)、@return、@raise,除非明确不适用;公开 initialize 在初始化属于公开契约时需加 @param;私有方法仅在行为不明显时记录,标签规则相同;每个异常类单独一个 @raise,禁止合并多个异常;对 .call 或复杂返回值,@return 必须写明确切结构;TODO:、FIXME:、HACK:、NOTE:、OPTIMIZE: 等标记须带可执行上下文,不得裸写;除用户明确要求外,文本使用英文。
使用方式:先定位新增或修改的公开类、模块与方法;补类级文档;为每个公开方法补方法与标签;描述可传播到调用方的异常,并把转换后的错误结果写在 @return;用 yard stats --list-undoc 和 yard doc 验证无遗漏。实现或修改公开 Ruby API 后,须先补齐 YARD 才算完成;产出或评审任务清单时,要在实现后加入明确的 YARD 子任务。
适用场景:服务对象实现后、文档化 API 客户端层(Auth、Client、Fetcher、Builder)、代码评审中核对公开接口是否已文档化时可串联使用。
限制:仅规定 YARD 文档写法与检查流程,具体项目结构、Ruby 版本、安装方式暂未提供;示例代码仅为标签用法示意。