Jak otevřít a převést POD do PDF pro čtení dokumentace Perl

reklama

Ačkoli to bylo kdysi integrální jazyk pro programování webu Jaký programovací jazyk se učit - webové programováníDnes se podíváme na různé webové programovací jazyky, které pohánějí internet. Toto je čtvrtá část programovací série pro začátečníky. V části 1 jsme se naučili základní ... Přečtěte si více , Perl nyní upadl na vedlejší kolej ve prospěch modernějších jazyků, jako jsou Python, Ruby a JavaScript. Jen velmi málo lidí si myslí, že stojí za námahu naučit se Perl v těchto dnech.

To však neznamená, že jazyk je k ničemu nebo zastaralý. Mnoho moderních webů a webových nástrojů se ve skutečnosti stále spoléhá na Perl pro každodenní provoz - včetně Craigslistu, IMDb a DuckDuckGo - takže pokud vás to zajímá, nedovolte, aby vás někdo zastavil nebo odradil 7 užitečných triků pro zvládnutí nového programovacího jazykaJe v pořádku být ohromen, když se učíte kódovat. Pravděpodobně zapomenete na věci tak rychle, jak se je naučíte. Tyto tipy vám mohou pomoci lépe uchovat všechny nové informace. Přečtěte si více .

Pokud se chcete Perl naučit, budete se také chtít seznámit s POD. Tady je to, proč je to důležité, a co dělat, když narazíte na takové soubory.

Co jsou soubory POD?

POD je zkratka pro Plain Old Documentation, což je základní značkovací jazyk, který se používá k formátování textu bez velkého úsilí. Je to podobné značkovací jazyk Markdown Co je Markdown? 4 důvody, proč byste se měli učit hned teďUž vás nebaví editory HTML a WYSIWYG? Pak je Markdown pro vás odpovědí bez ohledu na to, kdo jste. Přečtěte si více , ale speciálně určené pro dokumentaci zdrojového kódu a modulů Perl.

POD lze použít dvěma způsoby: může existovat přímo ve zdrojovém kódu souboru Perl NEBO může existovat jako samostatný soubor POD. Pokud v kódu existuje, můžete si o něm myslet jako o komentářích v jakémkoli jiném programovacím jazyce, s výjimkou vynalézavějšího a flexibilnějšího.

#! / usr / bin / perl

používat přísně;

používat varování;

= pod

= head1 Příklad záhlaví

Tento skript dělá některé skvělé věci, jako je tento a tak. Pro správnou funkci musí existovat následující parametry. Nezkoušejte to dělat na stroji s problémy.

= řez

print „Spustí se pouze tento kód. \ n ”;

Vestavěná dokumentace funguje dobře pro samostatné skripty nebo když chcete zajistit, aby každý, kdo soubor narazil, také má zaručený přístup k dokumentaci, ale může to být těžkopádné, pokud chcete dokumentovat celou kódovou základnu na vyšší úrovni úroveň.

Naštěstí lze POD také použít k vytvoření stránek manuálního typu, které jsou vhodnější pro dokumenty orientované na uživatele (protože uživatelé nemusí chtít ponořit do zdrojového kódu samotného skriptu). To je, když se soubory POD hodí.

Jak číst soubory POD

Aby bylo jasné, vložená dokumentace POD se nachází v aktuálních souborech skriptu Perl mezi řádky kódu a tyto soubory skriptu jsou dodávány v jednom ze dvou formátů přípon: .PL nebo .PM. Když uvidíte příponu .POD, znamená to, že soubor je čistě dokumentace a neobsahuje žádný zdrojový kód.

I když je možné otevírat soubory POD v jakémkoli textovém editoru, včetně programu Poznámkový blok, pravděpodobně to budete chtít udělat pouze tehdy, pokud skutečně upravujete samotnou nezpracovanou dokumentaci. Přemýšlejte o tom jako o otevření souboru HTML v editoru: se všemi značkami je skutečný textový obsah obtížně čitelný.

Místo toho byste měli použít nějaký nástroj pro čtení, který vezme prvotní dokumentaci POD a prezentuje ji snadno čitelným způsobem.

Nejjednodušší způsob je použít perldoc nástroj příkazového řádku, který je automaticky zahrnut, když Perl je nainstalován do vašeho systému. Většina systémů OS X a Linux přichází s již nainstalovaným Perlem, ale uživatelé Windows ho budou muset nainstalovat ručně. (Naštěstí to není o nic těžší než spuštění instalačního souboru.)

Nyní spusťte příkazový řádek, přejděte do umístění souboru POD a zadejte perldoc [.POD soubor] zobrazit jako správně naformátovaný. Například pokud byl soubor pojmenován library.pod pak napíšete perldoc library.pod a to je vše.

Jak převést POD na jiné formáty

I když perldoc nástroj není příliš obtížné používat, není to úplně pohodlné, pokud chcete sdílet dokumentaci s ostatními nebo když ji chcete číst z počítače. V tom případě můžete zvážit převod do jiného formátu.

Převod na HTML: Nainstalujte a použijte pod2html nástroj, který poskytuje snadný způsob, jak převést jakýkoli soubor POD do čitelného souboru HTML. Bohužel může provádět pouze konverzi jeden na jednoho (takže nelze kombinovat více souborů POD do jednoho souboru HTML).

Převod do formátu PDF: Nainstalujte a použijte pod2pdf nástroj, který je podobný a stejně snadno použitelný jako výše uvedený nástroj pod2html, kromě toho, že převádí spíše do formátu PDF než HTML.

Další možností by bylo převést POD do HTML pomocí výše uvedené metody, otevřít soubor HTML v prohlížeči, jako je Chrome nebo Firefox, a poté stránku vytisknout jako PDF.

Převod na Markdown: Nainstalujte a použijte pod2markdown nástroj pro překlad mezi POD a Markdown. Markdown je značkovací jazyk pro obecné použití, což znamená, že uživatelé s ním budou pravděpodobně lépe obeznámeni a existuje více nástrojů, které mohou Markdown akceptovat a zobrazit.

Převod na LaTeX: Nainstalujte a použijte pod2latex nástroj. LaTeX je další značkovací jazyk, který je méně běžný než Markdown, ale stále populárnější než POD. LaTeX se používá hlavně v akademických a vědeckých dokumentech, ale v případě, že jej potřebujete, tento převodník existuje.

Převod na prostý text: Nainstalujte a použijte pod2text nástroj, který vytváří textový soubor s formátováním založeným na ASCII. Pravděpodobně to nebudete muset použít, ale v případě, že to někdy uděláte, víte, že možnost existuje.

Byl tento příspěvek užitečný?

Jakmile na to narazíte, jsou soubory POD velmi jednoduché a pohodlné. Existuje trochu křivka učení, ale je to velmi malé - zejména pokud jste již dříve používali značkovací jazyk. Doufejme, že se nyní budete cítit pohodlně při práci se soubory POD.

Pokud se cítíte ohromeni, zeptejte se sami sebe důležité otázky pro nováčky kodéry 4 otázky, které byste si měli položit, než se naučíte kódovatUčení programovacího jazyka je oblíbené. Ale je to pro každého? Než se k tomu zavazujete, položte si následující otázky a buďte upřímní. Přečtěte si více . Problémy to nemusí nutně znamenat nemáte v úmyslu být programátorem 6 Známky toho, že nemáte na mysli programátoraNe každý je vyříznut jako programátor. Pokud si nejste zcela jisti, že jste chtěli být programátorem, zde jsou některé náznaky, které vás mohou nasměrovat správným směrem. Přečtěte si více , ale je důležité být k sobě upřímný a řídit svá očekávání.

Jak již bylo řečeno, tyto tipy dodržujte naučit se kódovat bez stresu Jak se naučit programování bez stresuMožná jste se rozhodli pokračovat v programování, ať už pro kariéru nebo jen jako koníček. Skvělý! Ale možná se začínáte cítit ohromeni. Není to tak skvělé. Zde je nápověda, která vám usnadní cestu. Přečtěte si více a vědět jak poznat dobré programovací návody od špatných Co dělá dobrý programovací výukový program?Ne všechny programovací návody jsou rovnocenné. Některé z vás a ostatních nakonec ztratí čas. Zde je, co hledat v kvalitním programovacím tutoriálu. Přečtěte si více .

Na co používáte Perl? Máte nějaké další tipy, které můžete sdílet nebo se na něco zeptat? Dejte nám vědět v komentářích níže!