Modul PODs

Want create site? Find Free WordPress Themes and plugins.

Hülsen-Modul

Die Dokumentation für Perl-Module in einer einfachen Auszeichnungssprache namens POD (Plain Old Dokumentation) geschrieben.

Diese Seite zeigt, wie ein Modul für Perl POD zu schreiben. Wenn Sie den Stil halten, dann wird es einfacher sein, für andere zu lesen und verstehen Ihre Dokumentation.

POD h2xscuireann Rahmen am Ende der .pm Datei schreibt. Lesen Sie die Schoten in bestehenden Modulen für weitere Beispiele.

= Head1 NAMEN

Geometrie :: Kreis – schafft Kreis

Der NAME-Abschnitt enthält den Namen des Moduls und einzeilige Beschreibung.

Name und durch einen Bindestrich getrennt. Es ist wichtig, dieses Format zu halten, so dass es an der POD-man-Seite rechts umgewandelt werden.

= Head1 Zusammenfassung

Geometrie verwendet :: Kreis

$ = New Kreis Kreis Geometrie :: $ x, $ y, $ e

($ X, $ y) = $ kreis-> Zentrum;
$ Radius = $ Kreis-> Radius;
$ = $ Kreis- Bereich> Bereich

$ P = $ Geometrie :: Kreis :: PI;

Synopsis Abschnitt zeigt die wesentlichen Stufen in dem Modul ein: mit der Anweisung, alle Subroutinen, Klassenmethoden oder Variablen, und alle Arten von Objekten. Methodenaufrufe sollten ihre Parameter und Rückgabewerte anzuzeigen.

jede Zeile in der Zusammenfassung einrücken. Dieser Artikel wörtlich, und stellt sicher, dass Ihre Ausrichtung zu bewahren.

Benötigt = head1

Perl5.8.8, Exporteur, Geometrie :: Punkt

Der BRAUCHT Abschnitt teilt dem Benutzer mit, was sie brauchen um das Modul zu verwenden.
EXPORTE = head1

nichts

Die Abteilung EXPORTE teilt dem Benutzer mit, was das Modul ihre Namensraum machen, wenn sie die EASA sind.
= Head1 BESCHREIBUNG

Geometrie :: Kreis schafft Kreise.
Verfahren zum Erstellen
Kreise und Computerbereiche.

Dies ist eine Beschreibung des Moduls.

Es sollte nicht der Programmierer in Bezug auf den Benutzer geschrieben werden.

  • Was bedeutet es für den Benutzer tun?
  • Wie verwenden Sie?
  • Was bedeutet es unterstützen?
  • Welche Methoden liefert sie?
= Head1 METHODEN

Creation = head2

= Über 4

Artikel = new Kreis Geometrie :: $ x, $ y, $ radius

Und Versandkosten
neue Sache Geometrie :: Kreis
mit dem Mittelpunkt ($ x, $ y) und den Radius $ Radius.

Rückkehr;

= Head2 Zugang

= Über 4

Kreis- $ item => Zentrum

Gibt eine Liste von x, y-Koordinaten
Mitte des Kreises.

Im skalaren Kontext,
gibt eine Referenz-Array.

= Artikel $ Kreis-> Radius

Gibt den Radius des Kreises.

Kreis- $ item => Bereich

Gibt Fläche des Kreises.

Rückkehr;

Die Methoden Abschnitt enthält und beschreibt jede Methode in der Klasse.

Sie können mehr Methoden der Level-2-Überschriften, wie Schöpfung, Accessagus Programm organisieren.

CLASS = head1 VARIABLES

= Über 4

$ Item = Kreis Geometrie :: :: PI

Das Verhältnis des Umfangs
Kreis mit dem Durchmesser.

Rückkehr;

Klassenvariablen Der variable Abschnitt ist jedes Paket in der API.
= Head1 DIAGNOSE

= Über 4

Item = en Negative

(F) einen Kreis mit negativem Radius erstellen.

Rückkehr;

Abschnitt DIAGNOSE liefert den Text jeder Fehlermeldung kann das Modul erzeugen, und erklärt seine Bedeutung.

Fehlermeldungen werden wie folgt eingeteilt:

(W)

Warnung (optional)

(D)

A deprecation (optional)

(S)

Warnung schwere (obligatorisch)

(F)

Ein schwerwiegender Fehler (auffangbar)

(X)

Die schwerwiegenden Fehler (Nicht-auffangbar)

= Head1 AUTOR

AU Thor, author@a.galaxy.far.far.away

Sie sollten Ihren Namen und Ihre E-Mail-Adresse, falls jemand muss kontaktieren Sie über das Modul senden.
= Head1 SIEHE AUCH

Perl (1), Geometrie :: Platz

Dies ist die übliche Liste der Programme und dazugehörige Module.
schneiden; = Cutseasann das Ende der Textzeile POD.

Einige Leute verteilen POD Teile für den Quellcode. Perl erkennt den Pod und vernachlässigten Abschnitte.

Did you find apk for android? You can find new Free Android Games and apps.