Комментирование кода

[Srednas]

Здравствуйте.

Подскажите как правильно комментировать код, чтобы потом на его основе можно было создать справку?
Что-то слышал, что есть специальные программы для «обхода» кода и составлению из него документации.

[-De-]

Гугли asdoc

[in4core]

Srednas пользуясь флеш девелопом , смотри примеры документирования стандартных флеш классов , точно так же описываешь свои , param там @ и т.п. Далее подключаешь asdoc - генерится документация

[Frost47rus]

в фд комментарий к функе или параметру - пишется /**
и нажимается пробел
FD автоматом проставит следующие строки со знаками - останется только их заполнить

[caseyryan]

и нажимается пробел
enter, если быть точнее

[blanzh]

возможно немного не в тему, но... Существуют аналоги asdoc, генерирующие доку похожую на оф. справочник AS3 (http://help.adobe.com/ru_RU/FlashPlatform/reference/actionscript/3/)?
Нашел rich-docs, но не пользовал, т.к. денег просит.

[wvxvw]

Вместе с Flex SDK в комплекте идет утилита asdocs с ее использованием и генерировалась справка (та что на сайте Адоби, да и вообще многих, кто публикует справку по AS коду).
http://www.flasher.ru/forum/showthread.php?t=137989
В прикрепленной теме есть несколько ссылок на описание работы утилиты.
Если, по каким-то причинам, работа утилиты не устроила, относительно хорошая поддержка есть у NaturalDocs. Если сравнивать полученные результаты от того и от другого - ASDocs, в какой-то степени надежнее (проверено на шкуре других :)). Известны баги и как бороться. NaturalDocs мало известна в мире флеша, но вобщем-то хорошо зарекомендовавшая себя утилита в других областях.
HTML на выходе у NaturalDocs получается не в пример красивше.
Когда-то был такой человек известный во флешевом мире по имени senocular, он написал то ли утилиту, то ли расширение к утилите для тех же целей. Кажется называлось ZenDoc. Но почти наверняка проект зачах и не поддерживается.