現在、ドキュメントに次のサンプル コードがあります。
some_keeper = SomeKeeper.new
some_keeper.report
# ...
# save the report to a file
# ...
some_keeper.fix!
save the report to a file後で埋められることはありません。ドキュメントには「不足しているコード」スニペットとしてそのまま残ります。
ドキュメントに「コードの欠落」の基準はありますか?
注: 私は Ruby で書いており、ドキュメントには Yardoc を使用しています。