perl - PerlのPODコメントを書くための規則はありますか？

Question

Safari Books Onlineからテンプレートを提供するページを見つけることができましたが、PODコメントを書いたことがないので、それがどれほど優れているか、または慣例と見なされる可能性のあるものが欠落しているかどうかはわかりません。

PerlスクリプトのPODコメントを書くときに従うべき規則は何ですか？SunのJavadocコンベンションのようなものはありますが、PODコメント用ですか？

Answer 1

手の込んだものではありませんが、Juerdのperlpodtutの紹介がとても好きです。

著者は、彼が一般的なセクションと見なすものと、それらに含まれるものについて言及しています。

Answer 2

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

Answer 3

Perl::Criticは次のポリシーを提供します。

• Perl :: Critic :: Policy :: Documentation :: PodSpelling

• Perl :: Critic :: Policy :: Documentation :: RequirePackageMatchesPodName

• Perl :: Critic :: Policy :: Documentation :: RequirePodAtEnd

• Perl :: Critic :: Policy :: Documentation :: RequirePodSections

必要なセクションのリストは、上記の最後のポリシーによって提供されます。

Module :: Starter :: PBPは、ボイラープレートコードを生成します。

Answer 4

CPAN SearchでPerlモジュールのポッドを見て、誰もが行っていることにすばやく気付くことができます。さまざまなモジュール起動ツールがボイラープレートを作成します。

これは、ガイドラインに到達するのとほぼ同じです。