【Ruby3.x】Gem::Specification::extra_rdoc_files()メソッドの使い方
extra_rdoc_filesメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
extra_rdoc_filesメソッドは、RubyGemsのパッケージ（gem）の情報を定義するGem::Specificationクラスにおいて、RDoc（Rubyのドキュメント生成ツール）がドキュメントを作成する際に、通常のソースコードファイル以外に追加で含めるべきファイルを指定するメソッドです。
Gem::Specificationクラスは、Rubyのライブラリやアプリケーションをパッケージ化するRubyGemsにおいて、そのgemの名前、バージョン、依存関係、含まれるファイルといった重要なメタデータを記述するために使用されます。
このextra_rdoc_filesメソッドを使用すると、開発者はREADMEファイル、CHANGELOGファイル、LICENSEファイルなど、gemに関する補足的な情報が含まれるファイルを、生成されるドキュメントに含めることができます。これらのファイルは、gemの機能や使用方法だけでなく、開発経緯やライセンス情報など、gemを利用する上で非常に役立つ情報を提供します。
具体的には、このメソッドに含めたいファイルパスの文字列の配列を渡すことで、指定されたファイルがRDocによるドキュメント生成プロセスに取り込まれます。これにより、gemがインストールされた環境でRDocコマンドを使ってドキュメントを生成した際や、RubyGems.orgなどのサービスで公開された際に、ユーザーはより包括的な情報を参照できるようになります。この設定は、gemの利用者にとって、より理解を深めるための重要な情報源となります。
構文(syntax)
1spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
引数(parameters)
引数なし
引数はありません
戻り値(return)
Array<String>
このメソッドは、gem のドキュメント生成に使用される追加の RDoc ファイルのパスを格納した文字列の配列を返します。