2012-04-26 5 views
0

は今、私は自分のドキュメントに以下の例のコードを持っている:save the report to a fileは後に充填されないだろうドキュメントにコードがないコード例を書くには?

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

、それだけで「行方不明コード」スニペット、ドキュメントでそのように残ります。

ドキュメントに「コードがありません」という標準がありますか?

注:私はRubyで書いており、ドキュメントにはYardocを使用しています。

答えて

0

利用可能なタグのリストはhereです。行方不明のタグはありませんが、メモを追加することができます。ただし、define_tagを使用して独自のタグを定義することもできます。

つまり、独自の@missingタグを定義できます。

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

+0

私は十分に明確ではありませんでした。私が投稿したコードは、ドキュメントスニペット_inside_です。欠落しているコード部分は例の一部です。 – Kostas

関連する問題