Azərbaycanca
Беларускі
Dansk
Deutsch
Española
Français
Indonesia
Italiana
日本語
Қазақ
Lietuvos
Nederlands
Português
Русский
සිංහල
แบบไทย
Türkçe
Українська
中國人
United State
Afrikaans
POD формат (англ. Plain Old Documentation) — спрощена мова розмітки тексту, що використовується для документування Perl програм.
Особливості
POD формат розроблявся як проста й водночас практична мова документування. Вона цілеспрямовано не включає механізми для опису шрифтів, зображень, кольорів або таблиць. Основні цілі формату:
- простий для парсингу;
- простий для перетворювання в інші формати: man, HTML, txt, XML, TeX або Markdown тощо;
- легкість наведення зразків коду або їх частин;
- легкість читання в початковому вигляді, без попереднього форматування;
- легкість написання.
PseudoPOD — розширена версія POD формату, що підтримує таблиці та виноски, що називається PseudoPOD, та була розроблена й використана видавництвом O'Reilly & Associates для створення декількох Perl-книг, однією з яких є Programming Perl.
Pod дозволяє легко писати man-довідки для користувачів, на відміну від інших систем документування, таки як або Javadoc, які більш призначені для розробників й описують початковий код.
Використання
POD застосовується для формування більшості документів в Perl-спільноті. Це опис як самого Perl, так й опис майже всіх модулів до нього, статті на Perl.com [ 30 червня 2005 у Wayback Machine.], а також опис віртуальної машини Parrot.
Хоча документація в POD форматі може бути доволі просто прочитана в своєму первинному вигляді, зазвичай її конвертують в більш читабельні формати засобами perldoc.
Файли в форматі POD мають розширення .pod Також фрагменти документації в POD форматі, можуть бути безпосередньо в Perl коді, файли якого зазвичай мають розширення .pl або .pm. Perl-інтерпретатор розпізнає POD-документацію в коді та ігнорує її.
Приклад
Нижче приклад коректного за синтаксисом документу в POD форматі з дотриманням прийнятої структури організації в Perl суспільстві документів.
=head1 NAME My::Module - назва модуля =head1 SYNOPSIS my $object = My::Module->new(); print $object->as_string; =head1 DESCRIPTION use My::Module; Це неіснуючий модуль, він зроблений з метою продемонструвати POD формат. =head2 Methods =over 12 =item C<new> =item C<as_string> Повертає представлення об'єкта як строковому вигляді. В основному для налагодження. =back =head1 LICENSE Модуль розповсюджується на умовах GPL ліцензії. Див. <perlartistic>. =head1 AUTHOR Juerd - L<http://juerd.nl/> =head1 SEE ALSO L<perlpod>, L<perlpodspec> =cut Див. також
Примітки
- . Архів оригіналу за 17 липня 2018. Процитовано 5 серпня 2018.
- pod2html довідка
- pod2text довідка
- Juerd. . Архів оригіналу за 12 серпня 2017. Процитовано 2018.08.05.
Вікіпедія, Українська, Україна, книга, книги, бібліотека, стаття, читати, завантажити, безкоштовно, безкоштовно завантажити, mp3, відео, mp4, 3gp, jpg, jpeg, gif, png, малюнок, музика, пісня, фільм, книга, гра, ігри, мобільний, телефон, android, ios, apple, мобільний телефон, samsung, iphone, xiomi, xiaomi, redmi, honor, oppo, nokia, sonya, mi, ПК, web, Інтернет
POD format angl Plain Old Documentation sproshena mova rozmitki tekstu sho vikoristovuyetsya dlya dokumentuvannya Perl program OsoblivostiPOD format rozroblyavsya yak prosta j vodnochas praktichna mova dokumentuvannya Vona cilespryamovano ne vklyuchaye mehanizmi dlya opisu shriftiv zobrazhen koloriv abo tablic Osnovni cili formatu prostij dlya parsingu prostij dlya peretvoryuvannya v inshi formati man HTML txt XML TeX abo Markdown tosho legkist navedennya zrazkiv kodu abo yih chastin legkist chitannya v pochatkovomu viglyadi bez poperednogo formatuvannya legkist napisannya PseudoPOD rozshirena versiya POD formatu sho pidtrimuye tablici ta vinoski sho nazivayetsya PseudoPOD ta bula rozroblena j vikoristana vidavnictvom O Reilly amp Associates dlya stvorennya dekilkoh Perl knig odniyeyu z yakih ye Programming Perl Pod dozvolyaye legko pisati man dovidki dlya koristuvachiv na vidminu vid inshih sistem dokumentuvannya taki yak abo Javadoc yaki bilsh priznacheni dlya rozrobnikiv j opisuyut pochatkovij kod VikoristannyaPOD zastosovuyetsya dlya formuvannya bilshosti dokumentiv v Perl spilnoti Ce opis yak samogo Perl tak j opis majzhe vsih moduliv do nogo statti na Perl com 30 chervnya 2005 u Wayback Machine a takozh opis virtualnoyi mashini Parrot Hocha dokumentaciya v POD formati mozhe buti dovoli prosto prochitana v svoyemu pervinnomu viglyadi zazvichaj yiyi konvertuyut v bilsh chitabelni formati zasobami perldoc Fajli v formati POD mayut rozshirennya pod Takozh fragmenti dokumentaciyi v POD formati mozhut buti bezposeredno v Perl kodi fajli yakogo zazvichaj mayut rozshirennya pl abo pm Perl interpretator rozpiznaye POD dokumentaciyu v kodi ta ignoruye yiyi PrikladNizhche priklad korektnogo za sintaksisom dokumentu v POD formati z dotrimannyam prijnyatoyi strukturi organizaciyi v Perl suspilstvi dokumentiv head1 NAME My Module nazva modulya head1 SYNOPSIS my object My Module gt new print object gt as string head1 DESCRIPTION use My Module Ce neisnuyuchij modul vin zroblenij z metoyu prodemonstruvati POD format head2 Methods over 12 item C lt new gt item C lt as string gt Povertaye predstavlennya ob yekta yak strokovomu viglyadi V osnovnomu dlya nalagodzhennya back head1 LICENSE Modul rozpovsyudzhuyetsya na umovah GPL licenziyi Div lt perlartistic gt head1 AUTHOR Juerd L lt http juerd nl gt head1 SEE ALSO L lt perlpod gt L lt perlpodspec gt cutDiv takozhModul PerlPrimitki Arhiv originalu za 17 lipnya 2018 Procitovano 5 serpnya 2018 pod2html dovidka pod2text dovidka Juerd Arhiv originalu za 12 serpnya 2017 Procitovano 2018 08 05