如何编写代码示例，在代码中缺少代码？

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

可用标签列表可以找到here。没有标签丢失，但可以添加注释。但是，您也可以使用define_tag定义自己的标签。

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

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