<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 TRANSITIONAL//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=UTF-8">
<META NAME="GENERATOR" CONTENT="GtkHTML/3.32.2">
</HEAD>
<BODY>
Я тоже использую POD:) Вопрос лишь в подходе - есть ли более-менее устоявшийся стандарт для решения моих задач или каждый придумывает что-то свое?<BR>
<BR>
В Птн, 09/09/2011 в 18:49 +0300, Агнислав Онуфрийчук пишет:<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">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">s.gulko@gmail.com</A>><BR>
Кому: " Kiev Perl Users Group" <<A HREF="mailto:kiev-perl-users-group@googlegroups.com">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>
</BODY>
</HTML>