RDoc CONSTANT комментарии? - PullRequest
       31

RDoc CONSTANT комментарии?

0 голосов
/ 08 января 2009

В RDoc есть ли способ показывать постоянные комментарии? Я хотел бы прокомментировать константу в моем проекте, но, понимая, что они не отображаются в выходных данных RDoc. Я проверил документацию, в которой, вероятно, есть комментарии для их констант, но никогда не видел (http://www.ruby -doc.org / core / classes / Math.html ).

Возможно, что они показывают реализацию рядом с константой, поскольку предполагают, что это само за себя, но кажется, что комментарии также будут полезны.

1 Ответ

1 голос
/ 09 февраля 2009

Для меня это нормально, просто добавив комментарий над константой. Вы пытались поместить свой код и связанные с ним константы в модуль?

Я думаю, что в документации по модулю Math нет комментариев к константам, потому что это модуль C под капотом.

...