Я работал с конкретным продуктом (Request Tracker) и потому использовал стиль, принятый в нём. Там есть и input, и output.<br><br><div class="gmail_quote">9 сентября 2011 г. 18:54 пользователь Serg V. Gulko <span dir="ltr"><<a href="mailto:s.gulko@gmail.com">s.gulko@gmail.com</a>></span> написал:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><u></u>
<div>
Я тоже использую POD:) Вопрос лишь в подходе - есть ли более-менее устоявшийся стандарт для решения моих задач или каждый придумывает что-то свое?<br>
<br>
В Птн, 09/09/2011 в 18:49 +0300, Агнислав Онуфрийчук пишет:<div><div></div><div class="h5"><br>
<blockquote type="CITE">
Не соглашусь. Я, бывает, через 2 месяца не помню нюансы кода. Комменты использую всегда и везде. Естественно, не комментируя каждую строчку, но, чтобы, вспоминая через год, что ты тут делал, не вспоминать функционал всех циклов, условий и замыкания, а просмотреть комменты быстро "не то, не то, вот это".
</blockquote>
<blockquote type="CITE">
<br>
<br>
</blockquote>
<blockquote type="CITE">
По теме вопроса: использовал POD. Хватало с головой.<br>
<br>
</blockquote>
<blockquote type="CITE">
9 сентября 2011 г. 18:39 пользователь Dmitrii <<a href="mailto:q7u5@ukr.net" target="_blank">q7u5@ukr.net</a>> написал:<br>
<blockquote>
есть два варианта:<br>
1) Опытный программиста прочитает сам код и все поймет без каких либо комментариев (разве, что в очень редких случаев надо прокомментировать)<br>
2) Не опытный программиста НЕ прочитает, но ему комментарии НЕ помогут все равно!! разве, что книгу Вы писать в комментариях :)<br>
<br>
по этому: писать расписывать комментарии считают бессмысленным занятием<br>
<br>
<br>
<br>
--- Исходное сообщение ---<br>
От кого: " Serg V. Gulko" <<a href="mailto:s.gulko@gmail.com" target="_blank">s.gulko@gmail.com</a>><br>
Кому: " Kiev Perl Users Group" <<a href="mailto:kiev-perl-users-group@googlegroups.com" target="_blank">kiev-perl-users-group@googlegroups.com</a>><br>
Дата: 9 сентября 2011, 17:12:58<br>
Тема: Re: Best practice для оформления документации
</blockquote>
</blockquote>
<blockquote type="CITE">
<blockquote>
<br>
</blockquote>
</blockquote>
<blockquote type="CITE">
<blockquote>
<br>
<br>
<br>
> Коллеги, хотелось бы узнать, как Вы оформляете документацию к своему коду на Perl.<br>
> Есть ли какие-нибудь более-менее общепринятые рекомендации по оформлению методов классов.<br>
> Мне бы хотелось указывать входные аргументы, выходные параметры и исключения, если метод их порождает.<br>
><br>
> Сергей<br>
<br>
</blockquote>
</blockquote>
<blockquote type="CITE">
<br>
<br>
</blockquote>
<br>
</div></div></div>
</blockquote></div><br>