Re: Best practice для оформления документации

[Агнислав Онуфрийчук]

Я работал с конкретным продуктом (Request Tracker) и потому использовал
стиль, принятый в нём. Там есть и input, и output.

9 сентября 2011 г. 18:54 пользователь Serg V. Gulko <s.gulko at gmail.com>написал:

> **
> Я тоже использую POD:) Вопрос лишь в подходе - есть ли более-менее
> устоявшийся стандарт для решения моих задач или каждый придумывает что-то
> свое?
>
> В Птн, 09/09/2011 в 18:49 +0300, Агнислав Онуфрийчук пишет:
>
>  Не соглашусь. Я, бывает, через 2 месяца не помню нюансы кода. Комменты
> использую всегда и везде. Естественно, не комментируя каждую строчку, но,
> чтобы, вспоминая через год, что ты тут делал, не вспоминать функционал всех
> циклов, условий и замыкания, а просмотреть комменты быстро "не то, не то,
> вот это".
>
>
>
>  По теме вопроса: использовал POD. Хватало с головой.
>
>  9 сентября 2011 г. 18:39 пользователь Dmitrii <q7u5 at ukr.net> написал:
>
> есть два варианта:
> 1) Опытный программиста прочитает сам код и все поймет без каких либо
> комментариев (разве, что в очень редких случаев надо прокомментировать)
> 2) Не опытный программиста НЕ прочитает, но ему комментарии НЕ помогут все
> равно!! разве, что книгу Вы писать в комментариях :)
>
> по этому: писать расписывать комментарии считают бессмысленным занятием
>
>
>
>  --- Исходное сообщение ---
>  От кого: " Serg V. Gulko" <s.gulko at gmail.com>
>  Кому: " Kiev Perl Users Group" <kiev-perl-users-group at googlegroups.com>
>  Дата: 9 сентября 2011, 17:12:58
>  Тема: Re: Best practice для оформления документации
>
>
>
>
>
> > Коллеги, хотелось бы узнать, как Вы оформляете документацию к своему коду
> на Perl.
> > Есть ли какие-нибудь более-менее общепринятые рекомендации по оформлению
> методов классов.
> > Мне бы хотелось указывать входные аргументы, выходные параметры и
> исключения, если метод их порождает.
> >
> > Сергей
>
>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.pm.org/pipermail/kiev-pm/attachments/20110909/fb85e114/attachment.html>