隐藏YARD的方法（正确的方法）

Question

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

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

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

但是，@private @api private明确指出：

  

注意：建议不要使用此方法隐藏未记录的或“不重要”的方法。当Ruby可见性规则不能这样做时，此标记应仅用于标记私有对象。

如果我改为使用{{1}}，YARD（很好）会在文档中使用YARD documentation徽章标记这些方法，但仍会显示这些方法。

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

Answer 1

从我的有限测试中，我发现以下情况很有效（并且不会在文档中有明确的注释以避免您的用例）：

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

根据yard documentation：

  

@！visibility public |受保护私人

     

修改当前解析可见性（公共，受保护或私有）。

希望有所帮助。