ruby-on-rails - 定数値に関連するドキュメントを適切な方法で記述および表示するにはどうすればよいですか?

Question

Ruby on Rails 3.1.0 を使用しており、YARD 0.7.4 を使用しようとしています。定数値を文書化したいので、クラスで次のように述べます。

# [Fixnum] Test constant documentation.
TEST_CONSTANT = 1

yardoc(またはyard doc) コマンドを実行した後の HTML 出力は次のとおりです。

上の画像では、HTML ドキュメントが適切にレンダリング/生成されていないことが示されています。少なくとも、私が期待するほどではありません。YAML のドキュメントを読みましたが、まだ問題があります。定数値に関連するドキュメントをより適切に記述および表示するにはどうすればよいですか?

Answer 1

私もこの問題に遭遇し、Google からこの未回答の投稿が返されました。別のフォーラムlink_to_forumで Loren Segal (Yard の作成者) による回答を見つけました。完全を期すために、同じ問題に遭遇した人のためにこれを追加します。

他のオブジェクトを文書化するのと同じ方法で文書化します。定数の上にコメントを置くだけです。

# Documentation here
TEST_CONSTANT = 1   

ただし、少なくとも私にとっては、結果のフォーマットが少し奇妙に見えることに注意してください。最初に定数の名前をフォーマットし、次に説明と値を表示します。最初に説明があり、次に名前と値が続くと思います。