Как да отворите и конвертирате POD в PDF, за да прочетете документацията на Perl

реклама

Макар че някога беше ан интегрален език за уеб програмиране Кой език за програмиране да научите - уеб програмиранеДнес ще разгледаме различните езици за уеб програмиране, които захранват интернет. Това е четвъртата част в поредицата за програмиране за начинаещи. В част 1 научихме основните от ... Прочетете още , Perl вече е отстъпил в полза на по-модерни езици като Python, Ruby и JavaScript. Много малко хора смятат, че си струва да положите усилия да научите Perl в наши дни.

Но това не означава, че езикът е безполезен или остарял. Всъщност много съвременни уебсайтове и уеб инструменти все още разчитат на Perl за ежедневните операции - включително Craigslist, IMDb и DuckDuckGo - така че ако се интересувате да го научите, не позволявайте на никого да ви спира или разубеждава 7 полезни трика за овладяване на нов език за програмиранеДобре е да бъдете претоварени, когато се научите да кодирате. Вероятно ще забравите нещата толкова бързо, колкото ги научите. Тези съвети могат да ви помогнат да запазите по-добре цялата тази нова информация. Прочетете още .

Ако ще научите Perl, ще искате да се запознаете с POD. Ето какво е това, защо е важно и какво да правите, когато се натъкнете на такива файлове.

Какво представляват POD файловете?

POD означава „Обикновена стара документация“, която е основен език за маркиране, използван за форматиране на текст, без да се включват много усилия. Подобно е на езика за маркиране на Markdown Какво е Markdown? 4 причини защо трябва да го научите сегаУморихте се от HTML и WYSIWYG редактори? Тогава Markdown е отговорът за вас, независимо кой сте. Прочетете още , но специално проектиран за документиране на Perl изходен код и модули.

POD може да се използва по два начина: може да съществува директно в изходния код на Perl файл ИЛИ може да съществува като отделен POD файл. Когато той съществува в рамките на кода, можете да мислите за него като коментари на всеки друг език за програмиране, с изключение на по-фантазиран и по-гъвкав.

#! / ЮЕсАр / хамбар / Perl

използвайте стриктно;

използвайте предупреждения;

= пад

= head1 Пример за заглавие

Този сценарий прави някои готини неща, като този и този. Следните параметри трябва да съществуват, за да работи правилно. Не се опитвайте да правите това на машина с проблеми.

= разрез

печат „Само този код се изпълнява. \н";

Вградената документация работи добре за самостоятелни скриптове или когато искате да се уверите, че и всеки, който попадне на файла има гарантиран достъп до документацията, но може да бъде тромав, когато искате да документирате цяла кодова база на по-висока ниво.

За щастие, POD може да се използва и за създаване на страници от ръчен тип, които са по-подходящи за ориентирани към потребителя документи (тъй като потребителите може да не искат да се задълбочават в изходния код на самия скрипт). Точно тогава са удобни POD файловете.

Как да четете POD файлове

За да бъде ясно, вградената POD документация се намира в действителните файлове на скриптове Perl между редовете код и тези файлове на скриптове се предлагат в един от два формата за разширение: .PL или .PM. Когато видите разширение .POD, това показва, че файлът е чиста документация и не включва изходен код.

Въпреки че е възможно да отворите POD файлове във всеки текстов редактор, включително Notepad, вероятно това искате да направите само ако всъщност редактирате самата сурова документация. Мислете за това като отваряне на HTML файл в редактор: с цялата маркировка, действителното текстово съдържание е трудно за четене.

Вместо това трябва да използвате някакъв инструмент за четене, който взема суровата документация за POD и я представя по лесен за четене начин.

Най-лесният начин е да използвате perldoc инструмент за команден ред, който се включва автоматично, когато Perl е инсталиран във вашата система. Повечето OS X и Linux системи идват с вече инсталиран Perl, но потребителите на Windows ще трябва да го инсталират ръчно. (За щастие, това не е по-трудно от пускането на инсталационен файл.)

Сега стартирайте командния ред, отворете мястото, където се намира POD файлът, и въведете perldoc [.POD файл] за да го видите като правилно форматиран. Например, ако файлът е кръстен library.pod тогава бихте въвели perldoc library.pod и това е.

Как да конвертирате POD в други формати

Въпреки че perldoc инструментът не е твърде труден за използване, не е точно удобен, когато искате да споделите документацията с други хора или когато искате да я прочетете далеч от компютъра си. Точно тогава можете да помислите за преобразуване в друг формат.

Преобразуване в HTML: Инсталирайте и използвайте pod2html инструмент, който предоставя лесен начин за превеждане на всеки POD файл в четим HTML файл. За съжаление, той може да извърши само едно към едно преобразуване (така че не можете да комбинирате множество POD файлове в един HTML файл).

Преобразуване в PDF: Инсталирайте и използвайте pod2pdf инструмент, който е подобен и също толкова лесен за използване като инструмента pod2html по-горе, освен че се превръща в PDF, а не в HTML.

Друга опция би била да конвертирате POD в HTML с помощта на показания по-горе метод, отворете HTML файла в браузър като Chrome или Firefox и след това отпечатайте страницата като PDF.

Преобразуване в Markdown: Инсталирайте и използвайте pod2markdown инструмент за превод между POD и Markdown. Markdown е език за маркиране с общо предназначение, което означава, че потребителите са по-склонни да са запознати с него и има повече инструменти, които могат да приемат и показват Markdown.

Преобразуване в LaTeX: Инсталирайте и използвайте pod2latex инструмент. LaTeX е друг език за маркиране, който е по-рядък от Markdown, но все пак по-популярен от POD. LaTeX се използва главно в академични и научни документи, но в случай, че имате нужда, този конвертор съществува.

Преобразуване в обикновен текст: Инсталирайте и използвайте pod2text инструмент, който създава само текстов файл с ASCII базирано форматиране. Вероятно няма да е необходимо да използвате това, но в случай, че някога го направите, знайте, че опцията съществува.

Полезна ли беше тази публикация?

След като приключите, файловете POD са изключително лесни и удобни за използване. Има малко крива на обучение, но е много малка - особено ако сте използвали език за маркиране преди. Надяваме се, че сега се чувствате удобно да работите с POD файлове.

Ако се чувствате претоварени, попитайте себе си важни въпроси за начинаещи кодери 4 въпроса, които да си зададете, преди да се научите как да кодиратеИзучаването на език за програмиране е популярно. Но дали е за всеки? Преди да се ангажирате с него, задайте си следните въпроси и бъдете честни. Прочетете още . Това, че имаш затруднения, не означава непременно това не бихте искали да бъдете програмист 6 признака, че не искате да бъдете програмистНе всеки е изрязан да бъде програмист. Ако не сте напълно сигурни, че имате намерение да бъдете програмист, ето някои признаци, които могат да ви насочат в правилната посока. Прочетете още , но е важно да бъдете честни със себе си и да управлявате очакванията си.

Като се казва, внимавайте за тези съвети научаване как да кодираме без стрес Как да научите програмиране без целия стресМоже би сте решили да се занимавате с програмиране, било то за кариера или просто като хоби. Страхотен! Но може би започвате да се чувствате претоварени. Не е толкова страхотно. Ето помощ за улесняване на пътуването ви. Прочетете още и знаейки как да разкажа добри уроци за кодиране от лошо Какво прави добър урок за програмиране?Не всички уроци по програмиране са равни. Някои полза вие и други в крайна сметка губите времето си. Ето какво да търсите в урок за качествено програмиране. Прочетете още .

За какво използвате Perl? Имате ли други съвети за споделяне или въпроси, които да задавате? Уведомете ни в коментарите по-долу!