2009-01-08 40 views
0

在RDoc中,有什麼方法可以顯示常量註釋嗎?我想在我的一個項目中評論一個常量,但意識到它們不會出現在RDoc輸出中。我檢查了可能對其常量有評論的文檔,但從未看到任何文檔(http://www.ruby-doc.org/core/classes/Math.html)。RDoc CONSTANT的評論?

他們可能會在旁邊顯示常量的實現,假設這是不言自明的,但似乎評論也會有所幫助。

回答

1

只需在常量行上方添加註釋,它對我來說工作正常。 你有沒有嘗試把你的代碼和相關的常量在模塊中?

我認爲數學模塊的文檔沒有常量註釋的原因是因爲它是引擎蓋下的C模塊。