定数値に関連する文書を適切な方法で表示したり表示するにはどうすればよいですか？

Question

Ruby on Rails 3.1.0を使用していますが、YARD 0.7.4を使用しようとしています。

：私はyardoc（またはyard doc）コマンドは以下の通りです実行した後

# [Fixnum] Test constant documentation. 
TEST_CONSTANT = 1 

が、HTML出力：私は私のクラスでは、私はこれを述べるので、一定の値を文書化したいと思います上の画像では、少なくとも私が期待していたように、HTMLドキュメントがうまくレンダリング/生成されていないことが示されています。私はYAML documentationを読んでいますが、それでもまだ問題はあります：どのようにして定数値に関連したドキュメントを表示したり表示したりできますか？

Answer 1

私もこの問題に遭遇し、Googleはこの返信されていない投稿を返しました。別のフォーラムでLoren Segal（Yardの作成者）の回答が見つかりました：link_to_forum。完全性の理由から、私は同じ問題に遭遇する人々のためにこれを追加します：

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

# Documentation here 
TEST_CONSTANT = 1 

少なくとも私にとって、結果の書式設定はちょっと変わっています。最初に定数の名前をフォーマットし、次に説明と値を表示します。私は最初にその説明とそれに続く名前と値を期待します。