Gibt es Konventionen für das schreiben POD Kommentare für Perl?

Question

Ich war in der Lage zu finden eine Seite von Safari Books Online bietet Vorlage, sein , aber nie geschrieben POD Kommentare, ich bin mir nicht sicher, wie gut es ist, oder, wenn es fehlt, dass etwas sein könnte als Konvention zu gehören.

Was sind die Konventionen zu Folgen, wenn das schreiben POD Kommentare für Perl-Skripte?Gibt es etwas wie Sun Javadoc-Konventionen, aber für POD Kommentare?

Answer 1

Es ist nicht aufwendig, aber ich mag Juerd perlpodtut Einführung viel.

Der Autor erwähnt, was er gemeinsame Abschnitte hält und was sie enthalten.

Answer 2

Es gibt eine Reihe von Empfehlungen in Perl Best Practices . Das ganze Kapitel 7 Abdeckungen Dokumentation mit POD, und die besten Ansätze zur Dokumentation für Module, große Projekte etc. Es spricht auch über CPAN Konventionen. Das ist wahrscheinlich die beste Wahl.

Answer 3

Perl :: Critic die folgenden Richtlinien vor:

• Perl :: Critic :: Richtlinie :: Dokumentation :: PodSpelling

• Perl :: Critic :: Richtlinie :: Dokumentation :: RequirePackageMatchesPodName

• Perl :: Critic :: Richtlinie :: Dokumentation :: RequirePodAtEnd

• Perl :: Critic :: Richtlinie :: Dokumentation :: RequirePodSections

Eine Liste der erforderlichen Abschnitte wird durch die letzte Richtlinie über zur Verfügung gestellt.

Module :: Starter :: PBP generiert der Standardcode für Sie.

Answer 4

Sie können sich auf der Pod für die Perl-Module auf CPAN-Suche schnell und beachten Sie die Dinge, die jeder tut.Die verschiedenen module starten Werkzeuge machen die boilerplate für Sie.

Das ist ungefähr so nah wie Sie bekommen, um Richtlinien.