Ako otvoriť a previesť POD do PDF na čítanie dokumentácie Perl

Reklama

Aj keď to bolo kedysi integrálny jazyk pre programovanie webu Ktorý programovací jazyk sa má učiť - webové programovanieDnes sa pozrieme na rôzne webové programovacie jazyky, ktoré poháňajú internet. Toto je štvrtá časť programovacej série pre začiatočníkov. V časti 1 sme sa naučili základné ... Čítaj viac , Perl sa teraz dostal na vedľajšiu koľaj v prospech modernejších jazykov, ako sú Python, Ruby a JavaScript. Veľmi málo ľudí si myslí, že stojí za námahu naučiť sa Perl v týchto dňoch.

To však neznamená, že jazyk je k ničomu alebo zastaraný. V skutočnosti sa veľa moderných webových stránok a webových nástrojov spolieha na Perl pri každodenných operáciách - vrátane Craigslistu, IMDb a DuckDuckGo - takže ak sa o to chcete dozvedieť, Nedovoľte, aby vás niekto zastavil alebo odradil 7 užitočných trikov na zvládnutie nového programovacieho jazykaKeď sa učíte kódovať, je to v poriadku. Pravdepodobne zabudnete na veci tak rýchlo, ako sa ich naučíte. Tieto tipy vám môžu pomôcť lepšie si uchovať všetky tieto nové informácie. Čítaj viac .

Ak sa chcete Perl naučiť, budete sa tiež chcieť zoznámiť s POD. Toto je dôvod, prečo je to dôležité a čo robiť, keď narazíte na takéto súbory.

Čo sú súbory POD?

POD je skratka pre Plain Old Documentation, čo je základný značkovací jazyk, ktorý sa používa na formátovanie textu bez veľkého úsilia. Je to podobné značkovací jazyk Markdown Čo je Markdown? 4 dôvody, prečo by ste sa to mali naučiť terazUž vás nebaví editory HTML a WYSIWYG? Potom je Markdown odpoveďou bez ohľadu na to, kto ste. Čítaj viac , ale špeciálne navrhnuté na dokumentáciu zdrojového kódu a modulov Perl.

POD sa dá použiť dvoma spôsobmi: môže existovať priamo v zdrojovom kóde súboru Perl alebo môže existovať ako samostatný POD súbor. Ak existuje v kóde, môžete si ho predstaviť ako komentáre v akomkoľvek inom programovacom jazyku, s výnimkou vymyslených a flexibilnejších.

#! / Usr / bin / perl

používať prísne;

používať varovania;

= pod

= head1 Príklad hlavičky

Tento skript robí nejaké skvelé veci, ako je tento a ten. Aby správne fungoval, musia existovať nasledujúce parametre. Neskúšajte to urobiť na stroji, ktorý má problémy.

= cut

print „Vykoná sa iba tento kód. \ N ";

Vstavaná dokumentácia funguje dobre pre samostatné skripty alebo ak sa chcete uistiť, že každý, kto sa s súborom stretne, tiež má zaručený prístup k dokumentácii, ale môže to byť ťažkopádne, ak chcete dokumentovať celú kódovú základňu vyššie level.

Našťastie POD sa dá tiež použiť na vytvorenie manuálnych stránok, ktoré sú vhodnejšie pre dokumenty orientované na používateľa (pretože používatelia možno nebudú chcieť ponoriť do zdrojového kódu samotného skriptu). To je, keď sa súbory POD hodia.

Ako čítať súbory POD

Aby bolo jasné, vložená dokumentácia POD sa nachádza v skutočných súboroch skriptov Perl medzi riadkami kódu a tieto súbory skriptov sú dodávané v jednom z dvoch formátov prípony: .PL alebo .PM. Keď vidíte príponu .POD, znamená to, že súbor je iba dokumentáciou a neobsahuje žiaden zdrojový kód.

Aj keď je možné otvoriť súbory POD v ľubovoľnom textovom editore vrátane programu Poznámkový blok, pravdepodobne to chcete urobiť len vtedy, ak skutočne upravujete samotnú nespracovanú dokumentáciu. Zamyslite sa nad tým, ako by ste otvorili súbor HTML v editore: pri všetkých označeniach je skutočný textový obsah ťažko čitateľný.

Namiesto toho by ste mali použiť nejaký nástroj na čítanie, ktorý berie prvotnú dokumentáciu POD a prezentuje ju ľahko čitateľným spôsobom.

Najjednoduchší spôsob je použitie internetu perldoc príkazový riadok, ktorý je automaticky zahrnutý, keď Perl je nainštalovaný do vášho systému. Väčšina systémov OS X a Linux prichádza s nainštalovaným programom Perl, ale používatelia systému Windows ho budú musieť nainštalovať manuálne. (Našťastie to nie je ťažšie ako spustenie inštalačného súboru.)

Teraz spustite príkazový riadok, prejdite na miesto, kde sa nachádza súbor POD, a napíšte perldoc [.POD súbor] aby sa zobrazil ako správne naformátovaný. Napríklad, ak bol súbor pomenovaný library.pod potom napíšete perldoc library.pod a to je všetko.

Ako previesť POD na iné formáty

Aj keď perldoc použitie tohto nástroja nie je príliš ťažké, nie je to celkom praktické, keď chcete zdieľať dokumentáciu s ostatnými alebo keď ju chcete prečítať z počítača. Vtedy môžete zvážiť konverziu do iného formátu.

Prevod na HTML: Nainštalujte a používajte pod2html nástroj, ktorý poskytuje jednoduchý spôsob, ako preložiť akýkoľvek súbor POD do čitateľného súboru HTML. Bohužiaľ, môže vykonávať iba konverziu jeden na jedného (takže nemôžete kombinovať viac súborov POD do jedného súboru HTML).

Prevod do formátu PDF: Nainštalujte a používajte pod2pdf nástroj, ktorý je podobný a rovnako ľahko použiteľný ako vyššie uvedený nástroj pod2html, okrem toho, že prevádza skôr do formátu PDF než HTML.

Ďalšou možnosťou by bolo previesť POD do HTML pomocou metódy uvedenej vyššie, otvoriť súbor HTML v prehliadači, ako je Chrome alebo Firefox, a potom stránku vytlačiť ako PDF.

Prevod na Markdown: Nainštalujte a používajte pod2markdown nástroj na preklad medzi POD a Markdown. Markdown je značkovací jazyk pre všeobecné použitie, čo znamená, že používatelia ho pravdepodobne poznajú a existuje viac nástrojov, ktoré môžu Markdown akceptovať a zobraziť.

Prevod na LaTeX: Nainštalujte a používajte pod2latex nástrojom. LaTeX je ďalší značkovací jazyk, ktorý je menej bežný ako Markdown, ale stále populárnejší ako POD. LaTeX sa používa hlavne v akademických a vedeckých dokumentoch, ale v prípade, že ho potrebujete, tento prevodník existuje.

Prevod na obyčajný text: Nainštalujte a používajte pod2text nástroj, ktorý vytvára textový súbor s formátovaním založeným na ASCII. Pravdepodobne to nebudete musieť použiť, ale v prípade, že to niekedy urobíte, vedzte, že možnosť existuje.

Bol tento príspevok užitočný?

Akonáhle sa dostanete na kĺb, sú súbory POD veľmi jednoduché a pohodlné na používanie. Existuje trochu krivka učenia, ale je to veľmi malé - najmä ak ste už predtým používali značkovací jazyk. Dúfajme, že teraz sa budete cítiť pohodlne pri práci so súbormi POD.

Ak sa cítite ohromení, opýtajte sa sami seba dôležité otázky pre nováčikov 4 otázky, ktoré by ste si mali položiť skôr, ako sa naučíte kódovaťUčenie sa programovacieho jazyka je populárne. Ale je to pre každého? Skôr ako sa k tomu zaviažete, položte si nasledujúce otázky a buďte úprimní. Čítaj viac . Mať ťažkosti to nevyhnutne neznamená nechcel si byť programátor 6 Známky toho, že nemáte v úmysle stať sa programátoromNie každý je vyrezaný ako programátor. Ak si nie ste úplne istí, či ste programátorom, tu sú niektoré náznaky, ktoré vás môžu nasmerovať správnym smerom. Čítaj viac , ale je dôležité byť k sebe úprimný a riadiť svoje očakávania.

Ako už bolo povedané, dbajte na tieto tipy naučiť sa kódovať bez stresu Ako sa naučiť programovanie bez stresuMožno ste sa rozhodli venovať programovaniu, či už na kariéru alebo len ako koníček. Skvelé! Ale možno sa začínate cítiť ohromení. Nie také veľké. Tu je pomoc pri uľahčovaní vašej cesty. Čítaj viac a vedieť ako povedať dobré návody na programovanie zlé Čo robí dobrý programovací výukový program?Nie všetky programovacie návody sú rovnaké. Niektoré z vás a iných nakoniec stratia čas. Tu je to, čo hľadať v kvalitnom programovacom návode. Čítaj viac .

Na čo používate Perl? Máte nejaké ďalšie tipy na zdieľanie alebo otázky? Dajte nám vedieť v komentároch nižšie!