Tavallinen vanha dokumentaatio

Pelkkä vanha dokumentaatio ( eng.  Plain old documentation , lyhenne pod ; merkitykseltään lähellä alkuperäistä venäläistä ilmaisua "Good Old Documentation") on yksinkertainen merkintäkieli, jota käytetään dokumentoimaan Perl -ohjelmointikieli .

Laite

Pod on suunniteltu yksinkertaiseksi ja puhtaaksi kieleksi, jolla on minimaalinen hyödyllinen syntaksi. Se sulkee tarkoituksella pois mekanismit kirjasimien, kuvien, värien tai taulukoiden kuvaamiseksi. Vaikka Pod ei ole yhtä ilmaisuvoimainen kuin XML :n tai LaTeX :n kaltaiset kielet, kirjoittajat ovat tarkoituksella uhraaneet ilmaisukyvyn yksinkertaisuuden ja mukavuuden vuoksi [1] . Koteloiden kehittämisen päätavoitteet ovat:

Tämä muoto on kuvattu perlpod-manuaalisivulla , ja jotkut pod-kääntäjät on kuvattu pod2man- , pod2html- ja pod2text- man-sivuilla . Vaikka perlpod-käsikirjan kirjoittajat huomauttavat, että podin ominaisuudet eivät todennäköisesti riitä kirjojen kirjoittamiseen siihen [2] , itse asiassa podista on kirjoitettu laajennettu versio. Tämä laajennettu versio sisältää ominaisuuksia taulukon muotoiluun ja alaviitteisiin, ja O'Reilly & Associates on käyttänyt sitä tuottaakseen useita kirjoja Perlistä (tunnetuin Perl Programming [1] Larry Wallilta, Tom Christiansenilta ja John Orvantilta). Toista laajennettua versiota podista, nimeltään mod, käytettiin Mark Jason Dominuksen en:Higher-Order Perl -kirjassa.

Ohjelmiston sisäänrakennetun POD-dokumentaation käyttäminen

Voit lukea ohjelmaan sisäänrakennetun muotoillun POD-dokumentaation mukana toimitetulla katseluohjelmalla:

% perldoc-ohjelma_ja_pod % perldoc perpod

Lisäksi POD-dokumentaatio on erittäin helppolukuinen, kun tarkastellaan moduulin lähdekoodia.

POD-muodossa oleva kuvaus voidaan muuntaa web-sivuksi perl-apuohjelmalla:

%pod2html --outfile = program.html program_with_pod

Voit muuntaa asiakirjat pelkkäksi tekstimuotoon käyttämällä:

pod2teksti tiedostonimi.pm > tiedostonimi.txt


Esimerkkikoodi

POD-dokumentaatio lisätty tiedoston loppuun:

#!/usr/local/bin/perl hei (); sub hello { tulosta "Hei, maailma!\n" ; } __END__ # Tyhjä merkkijono vaaditaan =head1 NIMI # Ohjelman tai moduulin nimi =head1 YHTEENVETO # Yksi rivi, joka kuvaa moduulin tai ohjelman tekemistä =head1 KUVAUS # Documentation array =head1 AUTHOR # Kuka olet =head1 BUGS # Mikä meni pieleen =head1 KATSO MYÖS # lisäinformaatio

Muistiinpanot

  1. ↑ 1 2 Larry Wall, Tom Christiansen, John Orvant. Perl ohjelmointi = Ohjelmointi Perl. - "Symbol-Plus", 2010. - S. 686-703. — ISBN 5-93286-020-0 .
  2. ↑ "Pod-muoto ei välttämättä riitä kirjan kirjoittamiseen" . Haettu 8. heinäkuuta 2009. Arkistoitu alkuperäisestä 10. heinäkuuta 2009.