ruby - 如何编写文档中缺少代码的代码示例？

Question

现在我的文档中有以下示例代码：

some_keeper = SomeKeeper.new
some_keeper.report
# ...
# save the report to a file
# ...
some_keeper.fix!

save the report to a file稍后不会填写，它会像文档中的那样保持不变，一个“缺失的代码”片段。

文档中是否有“代码缺失”的标准？

注意：我正在用 Ruby 编写文档，并使用 Yardoc 作为文档。

Answer 1

可以在此处找到可用标签的列表。没有遗漏标签，但您可以添加注释。但是，您也可以使用 define_tag 定义自己的标签。

这意味着您可以定义自己的@missing标签。

http://rubydoc.info/docs/yard/file/docs/Tags.md#Adding_Custom_Tags