PODについて聞いたことがありますか?これは、Perl の標準的なドキュメント ツールです。POD は、コード内に実際に存在する単純なテキスト ドキュメント形式です。perl に付属するコマンドの 1 つにperldocがあります。これを使用して、任意の Perl コマンドの情報を取得できます。これらを試してください:
$ perldoc File::Find
$ perldoc -f split
POD ドキュメントを組み込むには、 CPANのすべての Perl モジュールが必要です。実際、これは CPAN Web ページ自体が構築される方法です。
それで、私はこれでどこに行きますか、そしてこれはあなたにどのように役立つでしょうか?
Perl プログラムに POD ドキュメントを含める必要があります。次に、pod2textコマンドを使用して、Perl プログラムの README を作成できます。
$ pod2text myperl.pl > README
これで問題の半分が処理されます。
残りの半分はもう少しトリッキーです。システムにPod::MarkdownをCPAN からインストールする必要があります。次に、このモジュールに付属のpod2markdownコマンドを実行して、ファイルのマークダウンバージョンを作成できます。
$ pod2markdown myperl.pl > README.md
結果:
- ドキュメントは、当然のことながら、Perl プログラム内に存在します。
- ユーザーは、
perldoc
プログラムを使用して、プログラムの完全なドキュメントを印刷できます。
pod2text
ツールを使用してファイルを作成できますREADME
。
pod2markdown
ツールを使用してファイルを作成できますREADME.md
。
- おまけとして、Perl に付属のPod::Usageモジュールを使用して、ユーザーがパラメーターを使用してプログラムを実行したときに表示されるヘルプ テキストとして POD ドキュメント (またはその一部) を表示
-help
できます。
つまり、ドキュメンテーションが存在する 1 つの場所で、いくつかのヘルパー プログラムを使用して、ファイル Github と必要なPerl ツールを作成しています。