Ruby / Rdoc中的“未记录的”常量

时间:2012-11-16 04:31:05

标签: ruby rdoc

以下代码剪断:

# ansi console color constants
COLOR_BLACK = 0
COLOR_RED = 1
COLOR_GREEN = 2
COLOR_YELLOW = 3
COLOR_BLUE = 4
COLOR_MAGENTA = 5
COLOR_CYAN = 6
COLOR_WHITE = 7

# functional color aliases
COLOR_WARN = COLOR_YELLOW
COLOR_ALERT = COLOR_RED
COLOR_CONFIRM = COLOR_GREEN
COLOR_NOTE = COLOR_BLUE

报告为10个未记录的常量。有没有办法在RDoc中“按组注释常量”?分别记录每个常量会略显愚蠢,我不想在doc中省略它们。

1 个答案:

答案 0 :(得分:0)

在我建议实施:constlist:指令后,我得到了rdoc-developer的每封邮件的以下答案,将COLOR_BLACK = 0简单记录为 COLOR_BLACK(0)

  

我会看到我能做什么,但由于我的时间有限,我可能无法将其添加到RDoc 4.0。

     

我想我可以通过使用一个单独的指令将常量放在一个部分(内部)来完成这项工作,该指令也将它们标记为覆盖报告中的文档。