ある条約に書くためのポッドのコメントのためのPerl?

Question

私を見つけることができました。ページからサファリの書籍のオンラインを提供する テンプレート, ものを記述ポッドのコメントなんなのかどのように良いのか、であれば足りるものに利用することも考えられる条約が含まれています。

その条約に従う場合書面にポッドのコメントのためのPerlスクリプト?があるように 日Javadoc条約, が、ポッドのコメント?

Answer 1

これは精巧ではないのですが、私はJuerdの perlpodtut の導入多くのことを好き。

著者は、彼が共通のセクションとそれらが含まれるであろうと考えるもの言及します。

Answer 2

Perlのベストプラクティスでの推奨事項のセットがあります。第7章の全体は、それはまた、CPANの規則について語っPODを使用して、ドキュメントをカバーし、そしてなどのモジュール、大規模プロジェクトのドキュメントへの最良のアプローチ。それはおそらくあなたの最善の策です。

Answer 3

Perl::評論家 提供は、以下の諸施策の

• Perl::評論家::ポリシー::ドキュメンテーション:PodSpelling

• Perl::評論家::ポリシー::ドキュメンテーション:RequirePackageMatchesPodName

• Perl::評論家::ポリシー::ドキュメンテーション:RequirePodAtEnd

• Perl::評論家::ポリシー::ドキュメンテーション:RequirePodSections

リストの必要な部分 の最後の方針です。

モジュール::スターター::PBP の定型コードです。

Answer 4

あなたは CPAN検索するにPerlモジュールのためのポッドを見て、すぐに誰もが行うことに事を注意することができます。ツールはあなたのための定型文を作り始め、様々なモジュールます。

それはあなたがガイドラインを買ってあげると同じくらい近いです。