【Ruby3.x】Gem::Specification::extra_rdoc_files=()メソッドの使い方
extra_rdoc_files=メソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
extra_rdoc_files=メソッドは、RubyGemsの仕様を定義するGem::Specificationオブジェクトに対して、追加のRDocドキュメントファイルを指定するメソッドです。RubyGemsで配布される各gemは、その詳細な情報やコードから自動的にドキュメントが生成されます。通常、このドキュメント生成にはソースコードや標準的なREADMEファイルが使用されますが、gemにはそれら以外にも、開発者がユーザーに読んでもらいたい特別なファイルが存在する場合があります。
このメソッドを使用することで、開発者はRDocが生成するドキュメントに含めたい、標準以外のファイルパスのリストを設定できます。たとえば、特定のライセンスファイルや、詳細な技術解説が含まれたMarkdownファイルなどをドキュメントに含めることが可能です。引数には、追加したいファイルへのパスを要素とする配列を指定します。これにより、gemのすべての関連情報が一貫した形式のドキュメントとして提供され、利用者がgemをより深く理解するのに役立ちます。この設定は、gemの配布パッケージに含まれるドキュメントの網羅性を高めるために利用されます。
構文(syntax)
1Gem::Specification.new do |spec| 2 spec.extra_rdoc_files = ["README.md", "CHANGELOG.md"] 3end
引数(parameters)
files
- files: RDocドキュメントとして含める追加のファイルパスの配列
戻り値(return)
Array<String>
このメソッドは、配列として指定された追加のRDocファイル名のリストを返します。