ruby - "undocumented"Ruby/Rdoc 中的常量

Question

以下代码被截取:

# 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 中“按组注释常量”？单独记录每个常量有点愚蠢，我不想从文档中省略它们。

Answer 1

在我建议实现 :conSTList: 指令后，我从 rdoc-developer 的每封邮件中得到以下答复，这将得到 COLOR_BLACK = 0 简单地记录为 < strong>COLOR_BLACK(0):

I'll see what I can do, but I may not be able to add it to RDoc 4.0 as my time is limited.

I think I can make this work by putting the constants in a section (internally) using a separate directive that also marks them as documented for the purposes of the coverage report.