ruby - 从 YARD 中隐藏一个方法(正确的方法)

Question

我正在使用 YARD记录我的一个 Ruby 项目。我有一些我不想包含在文档中的方法，例如 #inspect 和 #to_s 您希望存在并返回合理结果的东西。

可以使用 @private 标记和 yardoc --no-private 命令行选项隐藏这些方法:

# @private let's not document this
def inspect; ...; end

然而，YARD documentation在 @private 上明确指出:

Note: This method is not recommended for hiding undocumented or “unimportant” methods. This tag should only be used to mark objects private when Ruby visibility rules cannot do so.

如果我改用 @api private，YARD(很好地)用 private 标记方法文档中的徽章，但仍会显示它们。

是否有一种“合法”的方式来隐藏 YARD 输出中的方法？

Answer 1

从我有限的测试中，我注意到以下效果很好(并且没有在文档中有明确的注释来避免您的用例):

# @!visibility private
def inspect; ...; end

根据yard documentation :

@!visibility public | protected | private

Modifies the current parsing visibility (public, protected, or private).

希望对您有所帮助。