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

[Dmitrii]

есть два варианта:
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.
> Есть ли какие-нибудь более-менее общепринятые рекомендации по оформлению методов классов.
> Мне бы хотелось указывать входные аргументы, выходные параметры и исключения, если метод их порождает.
> 
> Сергей