Clever Geek Handbook

RDoc CONSTANT comments?

In RDoc, is there a way to show persistent comments? I would like to comment out the constant in my project and understand that they are not showing up in the RDoc output. I checked the documentation, which will probably contain comments for its constants, but never saw it ( http://www.ruby-doc.org/core/classes/Math.html ).

It is possible that they show the implementation next to the constant, since they assume it is self-evident, but it seems that comments would be helpful as well.

0


source to share


1 answer


It works great for me just by adding a comment above the constant line. Have you tried putting your code and associated constants into a module?



I think the reason is that the documentation for the Math module has no comments for constants, because it's a C module under the hood.

+1


source






More articles:


All Articles