RDoc CONSTANT评论?

时间:2009-01-08 18:13:56

标签: ruby documentation comments constants rdoc

在RDoc中,有没有办法显示常量注释?我想在我的一个项目中评论一个常量但是意识到它们不会出现在RDoc输出中。我查看了可能对其常量有评论的文档,但从未见过任何文件(http://www.ruby-doc.org/core/classes/Math.html)。

它们可能会显示常量旁边的实现,因为假设这是不言自明的,但似乎注释也会有所帮助。

1 个答案:

答案 0 :(得分:1)

通过在常量线上方添加注释,它对我来说很好。 您是否尝试将代码和相关常量放在模块中?

我认为Math模块的文档没有常量注释的原因是因为它是一个C模块。