Ich konnte eine Seite von Safari Books Online finden, die eine Vorlage enthält, aber noch keine POD-Kommentare geschrieben hat, Ich bin mir nicht sicher, wie gut es ist oder ob etwas fehlt, das als Konvention gelten könnte.
Welche Konventionen sind beim Schreiben von POD-Kommentaren für Perl-Skripte zu beachten? Gibt es etwas wie Suns Javadoc-Konventionen , aber für POD-Kommentare?
Es ist nicht aufwendig, aber ich mag Juerds perlpodtut Einführung sehr.
Der Autor erwähnt, was er für gemeinsame Abschnitte hält und was sie beinhalten würden.
Es gibt eine Reihe von Empfehlungen in Perl Best Practices . Das gesamte Kapitel 7 behandelt die Dokumentation, die Verwendung von POD und die besten Ansätze für die Dokumentation von Modulen, großen Projekten usw. Es spricht auch über CPAN-Konventionen. Das ist wahrscheinlich die beste Wahl.
Perl :: Critic bietet die folgenden Richtlinien:
Perl :: Critic :: Policy :: Documentation :: RequirePackageMatchesPodName
Perl :: Critic :: Policy :: Documentation :: RequirePodAtEnd
Perl :: Critic :: Richtlinien :: Dokumentation :: RequirePodSections
Eine Liste der erforderlichen Abschnitte wird von der letzte Richtlinie oben.
Module :: Starter :: PBP generiert den Standardcode für Sie.
Sie können den Pod für die Perl-Module auf der CPAN-Suche ansehen und schnell die Dinge notieren, die jeder tut. Die verschiedenen Modulstartwerkzeuge erstellen für Sie ein Muster.
Das ist ungefähr so nah, wie Sie zu Richtlinien kommen.