Modul PODs

Dokumentacija za module Perl je napisana v preprostem označevalnem jeziku, ki se imenuje POD (Plain Old Documentation).
Na tej strani je prikazano, kako napisati POD za modul Perl. Če se držite tega sloga, bodo drugim lažje prebrali in razumeli vašo dokumentacijo.

h2xs postavlja skelet POD na koncu datoteke .pm, ki jo piše. Za dodatne primere preberite PODs v obstoječih modulih.

= glavo1 NAME

Geometrija :: Krog - upravlja krog


V razdelku NAME se navede ime modula v opisni liniji.
Ime in opis sta ločena s pomišljajem. Pomembno je, da držite te oblike, tako da lahko POD spremenite na ustrezno stran človeka.
= glava 1 SYNOPSIS

   uporabite Geometry :: Krog

   $ circle = nova geometrija :: krog $ x, $ y, $ r

   ($ x, $ y) = $ circle-> središče;
   $ radius = $ circle-> polmer;
   $ area = $ circle-> območje

   $ pi = $ Geometrija :: Krog :: PI;
V oddelku SYNOPSIS so prikazani bistveni koraki pri uporabi modula: uporabniška izjava, vsa podprograma, metode razreda ali spremenljivke in vse metode objektov. Klici metode morajo navajati njihove parametre in povratne vrednosti.

Vsaka vrstica v povzetku se odstrani. Zaradi tega je dobesedni odstavek in zagotavlja, da bo vaša uskladitev ohranjena.

= glava1 ZAHTEVA

Perl5.8.8, Izvoznik, Geometrija :: Točka
Oddelek REQUIRES pove uporabniku, kaj bodo potrebovali za uporabo modula.
= head1 IZVOZ

Nič
Razdelek EXPORTS pove uporabniku, kaj bo modul naredil v svojem imenskem prostoru, če ga bo uporabil.
= head1 OPIS

Geometrija :: Krog upravlja krogi.
Za ustvarjanje so predvidene metode
kroge in računanje njihovih območij.

To je opis modula.

Treba je napisati v izrazih, ki so pomembni za uporabnika, ne pa za programerja.

  • Kaj to naredi za uporabnika?
  • Kako jo uporabite?
  • Katere predmete podpira?
  • Katere metode zagotavlja?

 

 

= glave1 METODE

= glava2 ustvarjanje

= več kot 4

= element nova geometrija :: krog $ x, $ y, $ radij

Ustvari in vrne a
novi Geometry :: Krog predmet
s središčem ($ x, $ y) in polmerom radia $.

= nazaj

= head2 Access

= več kot 4

= element $ circle-> center

Vrne seznam koordinat x, y
središča kroga.

V skalarnem kontekstu,
vrne referenčno polje matrike.

= element $ circle-> polmer

Vrne polmer kroga.

= element $ circle-> območje

Vrne območje kroga.

= nazaj

Oddelek METHODS navaja in opisuje vsako metodo v razredu.

Nadalje lahko organizirate metode pod postavkami ravni 2, kot so ustvarjanje, dostop in uporabnost.

= head1 RAZLIČNE SPREMENLJIVKE

= več kot 4

= element $ Geometrija :: krog :: PI

Razmerje oboda
kroga premera.

= nazaj

V razdelku RAZRED VARIABLES so naštete vse spremenljivke paketa v API-ju.
= glava1 DIAGNOSTIKA

= več kot 4

= element Negativni polmer

(F) Krog se ne sme ustvariti z negativnim polmerom.

= nazaj

Oddelek DIAGNOSTICS daje besedilo vsakega sporočila o napaki, ki ga modul lahko generira, in razloži njegov pomen.

Sporočila o napakah so razvrščena na naslednji način:

(W)

Opozorilo (neobvezno)

(D)

Opustitev (neobvezno)

(S)

Resno opozorilo (obvezno)

(F)

Fatalna napaka (trappable)

(X)

Zelo fatalna napaka (neuporabna)

= glava1 AUTHOR

A. U. Thor, a.u.thor@a.galaxy.far.far.away

Vključiti morate svoje ime in e-poštni naslov, če vas bo kdo moral kontaktirati glede modula.
= glava1 GLEJ TUDI

perl (1), Geometrija :: Trg
To je običajen seznam povezanih programov in modulov.
= razrez
Linija = rezka označuje konec POD-besedila.

Nekateri ljudje distribuirajo POD-razdelke po njihovi izvorni kodi. Perl prepozna dele POD in jih ignorira.

Odvzet od : http://world.std.com/~swmcd/steven/perl/module_pod.html

Leave a Reply

Your email address will not be published. Required fields are marked *