Documentație veche simplă

Documentația veche simplă ( eng.  Documentație veche simplă , abreviată ca pod ; înțeles apropiat de expresia rusă originală - „Good Old Documentation”) este un limbaj simplu de marcare folosit pentru a documenta limbajul de programare Perl .

Dispozitiv

Pod este conceput pentru a fi un limbaj simplu și curat, cu o sintaxă utilă minimă. Exclude în mod intenționat mecanismele de descriere a fonturilor, imaginilor, culorilor sau tabelelor. Deși Pod nu este la fel de expresiv ca limbajele precum XML sau LaTeX , autorii au sacrificat în mod deliberat expresivitatea de dragul simplității și al confortului [1] . Principalele obiective ale dezvoltării podului sunt:

Acest format este descris în pagina de manual perlpod , iar unii traducători de pod sunt descriși în paginile de manual pod2man , pod2html și pod2text . Deși autorii manualului perlpod subliniază că capabilitățile unui pod probabil nu sunt suficiente pentru a scrie cărți pe el [2] , de fapt există cărți scrise într-o versiune extinsă a podului. Această versiune extinsă include caracteristici pentru formatarea tabelelor și note de subsol și a fost folosită de O'Reilly & Associates pentru a produce mai multe cărți despre Perl (cel mai faimos Programming Perl [1] de Larry Wall , Tom Christiansen și John Orvant). O altă versiune extinsă a podului, numită mod, a fost folosită în cartea en:Higher-Order Perl de Mark Jason Dominus.

Folosind documentația POD încorporată a software-ului

Puteți citi documentația formatată POD încorporată în program folosind utilitarul de vizualizare furnizat:

% perldoc program_with_pod % perldoc perlpod

În plus, documentația POD este foarte ușor de citit când te uiți la codul sursă al unui modul.

O descriere în format POD poate fi convertită într-o pagină web cu utilitarul perl:

%pod2html --outfile = program.html program_with_pod

Pentru a converti documentația în format text simplu, puteți utiliza:

pod2text filename.pm > filename.txt


Exemplu de cod

Documentația POD adăugată la sfârșitul fișierului:

#!/usr/local/bin/perl salut (); sub salut { print "Bună ziua, lume!\n" ; } __SFÂRŞIT__ # Necesar șir gol =head1 NUME # Program sau nume modul =head1 SINOPSIS # O linie care descrie ceea ce face modulul sau programul =head1 DESCRIERE # Documentation array =head1 AUTHOR # Cine ești =head1 BUGS # Ce a mers prost =head1 VEZI ȘI # Informații suplimentare

Note

  1. ↑ 1 2 Larry Wall, Tom Christiansen, John Orvant. Programare Perl = Programare Perl. - „Simbol-Plus”, 2010. - S. 686-703. — ISBN 5-93286-020-0 .
  2. ↑ „Formatul Pod nu este neapărat suficient pentru a scrie o carte” . Preluat la 8 iulie 2009. Arhivat din original la 10 iulie 2009.