• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Perl POD
 

Perl POD

on

  • 3,871 views

 

Statistics

Views

Total Views
3,871
Views on SlideShare
3,757
Embed Views
114

Actions

Likes
1
Downloads
14
Comments
1

6 Embeds 114

http://kostenko.name 87
http://www.slideshare.net 17
http://www.linkedin.com 7
http://rstream.gugu.dev.rambler.ru:31336 1
http://webcache.googleusercontent.com 1
https://www.linkedin.com 1

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel

11 of 1 previous next

  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Perl POD Perl POD Presentation Transcript

    • Проектная документация Как сделать так, чтобы вас не проклинали потомки
    • Зачем нам её писать?
    • Глупый вопрос
    • Зачем? Структуру большого проекта не получится держать в голове Разбираться в чужом коде - то ещё удовольствие Возможность подключить к проекту новых программистов
    • Perl начнем с примера: package Test; sub do_nothing{} sub do_something{...} 1;
    • Немного теории Документация в Perl - это та часть файла, которая находится между =чтоугодно и =cut Например =pod Какой-то текст =cut
    • Структура POD-документа Обычный блок текста Дословный блок (отступ) Управляющий блок (=pod, =head1)
    • Управляющий блок =headN text - заголовок 1-4го уровня =pod - начало обычного блока текста =over отступ - установка отступа =item - элемент списка =back - возврат предыдущего отступа
    • Форматирование I<TEXT> - курсив (<i></i>) B<TEXT> - жирный (<b></b>) C<TEXT> - код L<LINK> - ссылка на секцию либо модуль  L<LINK|TITLE> - установка кастомного TITLE E<gt> - escapes like HTML F<.zshrc> - имя файла
    • Документируем модуль package Test; =head1 NAME Test - краткое описание модуля =head1 SYNOPSYS use Test; ... some example ... =head1 DESCRIPTION Большое и длинное описание модуля. =head1 METHODS =cut ...дальше следует код модуля... =head1 AUTHOR Andrey Kostenko <andrey@kostenko.name> =head1 LICENSE Microsoft EULA =cut
    • Документируем метод =head2 do_nothing Args: none Returns: nothing Actually does nothing =cut sub do_nothing { } =head2 do_something Args: $variable, %hash Returns: some data =cut
    • Либо Создаём файл с расширением .pod  и пишем туда документацию, не связанную с каким-либо кодом
    • Спасибо, Капитан Очевидность Возможно, я не рассказал вам ничего нового.   Но я очень надеюсь, что вы задумаетесь о необходимости документирования кода
    • =head1 AUTHOR I<Andrey Kostenko> L<http://kostenko.name> L<mailto:a.kostenko@rambler-co.ru>