Форум Flasher.ru

Форум Flasher.ru (http://www.flasher.ru/forum/index.php)
-   Общие вопросы о Flash (не затрагивающие ActionScript) (http://www.flasher.ru/forum/forumdisplay.php?f=60)
-   -   Создание документации для кода (http://www.flasher.ru/forum/showthread.php?t=140569)

ikozlov 02.06.2010 15:56

Создание документации для кода
 
Создал проект с комментариями. хотелось бы получить документацию. В Java есть Javadoc. Есть ли что то похожее в AS?

proxiServer 02.06.2010 15:59

ASDoc

ikozlov 02.06.2010 16:22

большое спасибо!

Добавлено через 34 минуты
на сколько я понял ASDoc игнорирует private методы. нет ли решения как его научить? ну помимо изменения модификатора.

udaaff 02.06.2010 17:07

А зачем в доку пихать приватные методы? Логично в документации публичный интерфейс описывать. А те методы, которые приватные, кроме как в самом классе ты использовать не сможешь, соответственно, и достаточно будет того описания, что в самом классе.

ikozlov 02.06.2010 17:09

не соглашусь)
мне как раз интересно создать документацию для передачи проекта. прочитав которую, человек не заглядывая в код поймет что к чему.

Волгоградец 02.06.2010 19:16

ASDoc игнорирует приваты, только если использовать тэг @private.

ikozlov 03.06.2010 09:31

Цитата:

Сообщение от Волгоградец (Сообщение 912640)
ASDoc игнорирует приваты, только если использовать тэг @private.

У меня в комментариях нет спец тегов. т.е. просто коммент и просто модификатор private, но в доки он не попадает. может нужно указать спец тег?

udaaff 03.06.2010 09:56

Цитата:

Сообщение от Волгоградец (Сообщение 912640)
ASDoc игнорирует приваты, только если использовать тэг @private.

Последний раз когда пользовался ASDoc — игнорировал и без @private.

ikozlov 03.06.2010 10:13

У меня тоже игнорирует, по этому и спрашиваю на счет спец тега

AzagThoth 12.05.2012 15:00

Да, беда :(

У меня тоже игнорирует приватные методы. Извините пожалуйста за "АП" старой темы. Нашёл в поиске и побоялся новую создавать.
Может кто-то знает как сделать, чтобы дока по приватным методам создавалась?

Проект во FlashDevelop 4.0.1 RTM (R2198)
Утилита, для создания документации - Tools -> Flash Tools -> Documentation Generator...

Цель данных манипуляций создавать полезные классы, которые потом смогут наследоваться другими классами, которые в свою очередь, возможно, будут переопределять некие приватные методы.
Хочу научиться оформлять полноценное описание классов в виде документации. Также, если кому то известно как включить в документацию свойства класса и свойства экземпляров класса. Был бы рад если бы подсказали.


Часовой пояс GMT +4, время: 13:44.

Copyright © 1999-2008 Flasher.ru. All rights reserved.
Работает на vBulletin®. Copyright ©2000 - 2026, Jelsoft Enterprises Ltd. Перевод: zCarot
Администрация сайта не несёт ответственности за любую предоставленную посетителями информацию. Подробнее см. Правила.