Y a-t-il des conventions pour écrire des commentaires POD pour Perl?

Question

J'ai pu trouver une page de Safari Books Online qui fournit modèle, mais ayant jamais écrit commentaires POD, je ne sais pas comment il est bon ou s'il manque tout ce qui pourrait être considéré que la convention à inclure.

Quelles sont les conventions à suivre lors de l'écriture des commentaires POD pour les scripts Perl? Y at-il quelque chose comme Conventions Javadoc Sun , mais pour commentaires POD?

Answer 1

Il est précise pas, mais j'aime perlpodtut introduction beaucoup.

L'auteur mentionne ce qu'il considère comme des sections communes et ce qu'ils comprennent.

Answer 2

Il y a une série de recommandations dans Perl Best Practices . L'ensemble du chapitre 7 traite des documents, en utilisant POD, et la meilleure approche à la documentation des modules, de grands projets, etc. Il parle également de conventions CPAN. C'est probablement votre meilleur pari.

Answer 3

Perl :: Critique fournit les politiques suivantes:

• Perl :: Critique :: Politique :: Documentation :: PodSpelling

• Perl :: Critique :: Politique :: Documentation :: RequirePackageMatchesPodName

• Perl :: Critique :: Politique :: Documentation :: RequirePodAtEnd

• Perl :: Critique :: Politique :: Documentation :: RequirePodSections

Une liste des sections requises est fourni par la dernière politique ci-dessus.

Module de démarrage :: PBP générera le code passe-partout pour vous.

Answer 4

Vous pouvez consulter le Pod pour les modules Perl sur CPAN Recherche et notez rapidement les choses que tout le monde fait . Les différents modules à partir des outils font boilerplate pour vous.

C'est à peu près aussi proche que vous aurez des directives.