yard

RubyのYardでドキュメントを生成する方法と使い方を簡単に紹介します。 そもそも、yardというのはrubyの各メソッドやクラスに対してコメントを書きそれをもとに、 API（技術的な）ドキュメントを生成するもので、使い方は簡単です。

RubyのYardでドキュメントを生成する際に、あるメソッドはドキュメントに表示しなくても良い時があるかともいます。そのときに、特定のメソッドだけをドキュメントを生成しない方法 を紹介します。簡単で、`# @!visibility private`を使うことでそれが実現できます。