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

我也遇到了这个问题，谷歌给我回了这个未答复的帖子。我在另一个论坛中找到了 Loren Segal（Yard 的创建者）的答案：link_to_forum。出于完整性原因，我为遇到相同问题的人添加了这个：

您记录它的方式与记录任何其他对象的方式相同。只需将注释放在常量上方即可。

# Documentation here
TEST_CONSTANT = 1   

请注意，至少对我而言，生成的格式看起来有点奇怪。它首先格式化常量的名称，然后显示描述，然后显示值。我希望首先是描述，然后是名称和值。