Obyčejná stará dokumentace

Obyčejná stará dokumentace ( angl.  Plain old documents , zkráceně pod ; významově blízká původnímu ruskému výrazu - „Good Old Documentation“) je jednoduchý značkovací jazyk používaný k dokumentaci programovacího jazyka Perl .

Zařízení

Pod je navržen jako jednoduchý a čistý jazyk s minimální užitečnou syntaxí. Záměrně vylučuje mechanismy pro popis písem, obrázků, barev nebo tabulek. Přestože Pod není tak výrazný jako jazyky jako XML nebo LaTeX , autoři záměrně obětovali expresivitu kvůli jednoduchosti a pohodlí [1] . Hlavní cíle vývoje podstavců jsou:

Tento formát je popsán v manuálové stránce perlpod a některé překladače pod jsou popsány v manuálových stránkách pod2man , pod2html a pod2text . I když autoři příručky perlpod upozorňují, že schopnosti podu na psaní knih na něm pravděpodobně nestačí [2] , ve skutečnosti existují knihy psané v rozšířené verzi pod. Tato rozšířená verze obsahuje funkce pro formátování tabulek a poznámky pod čarou a byla použita společností O'Reilly & Associates k vytvoření několika knih o Perlu (nejslavnější Perl Programming [1] od Larryho Walla , Toma Christiansena a Johna Orvanta). Další rozšířená verze pod, nazvaná mod, byla použita v knize en:Higher-Order Perl od Marka Jasona Dominuse.

Použití vestavěné dokumentace POD softwaru

Formátovanou dokumentaci POD zabudovanou do programu si můžete přečíst pomocí dodaného nástroje prohlížeče:

% perldoc program_with_pod % perldoc perlpod

Dokumentace POD je navíc velmi snadno čitelná při pohledu na zdrojový kód modulu.

Popis ve formátu POD lze převést na webovou stránku pomocí nástroje perl:

%pod2html --outfile = program.html program_with_pod

Chcete-li převést dokumentaci do formátu prostého textu, můžete použít:

pod2text název_souboru.pm > název_souboru.txt


Ukázkový kód

Dokumentace POD přidána na konec souboru:

#!/usr/local/bin/perl ahoj (); sub ahoj { print "Ahoj světe!\n" ; } __KONEC__ # Je vyžadován prázdný řetězec =head1 NAME # Název programu nebo modulu =head1 SYNOPSE # Jeden řádek popisující, co modul nebo program dělá =head1 POPIS # Pole dokumentace =head1 AUTOR # Kdo jsi =head1 CHYBY # Co se pokazilo =head1 VIZ TAKÉ # dodatečné informace

Poznámky

  1. ↑ 1 2 Larry Wall, Tom Christiansen, John Orvant. Programování v Perlu = Programování v Perlu. - "Symbol-Plus", 2010. - S. 686-703. — ISBN 5-93286-020-0 .
  2. ↑ "Formát pod není nezbytně dostatečný pro napsání knihy" . Získáno 8. července 2009. Archivováno z originálu dne 10. července 2009.