RubyのYardで特定のメソッドのドキュメントを生成しない方法

RubyのYardでドキュメントを生成する際に、 あるメソッドはドキュメントに表示しなくても良い時があるかともいます。

そのときに、特定のメソッドだけをドキュメントを生成しない方法 を紹介します。 簡単で、# @!visibility privateを使うことでそれが実現できます。

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

--- https://www.rubydoc.info/gems/yard/file/docs/Tags.md#visibility

例えば、Greetingというクラスがありsay_hiとsay_greetingというメソッドがあり、say_greetingは時メントに表示したくない場合は下記のようにすると実現できます。

# greeting.rb
class Greeting
  # 挨拶のメソッド
  # @return nil
  def say_hi
   puts "hi"
  end 

  # @!visibility private
  def say_greeting
    puts "hello"
  end
end

これで、下記のようにドキュメントを生成してあげると、 say_greetingのメソッドはドキュメントには表示されないことがわかると思います。

yard doc greeting.rb