Форум Flasher.ru

Форум Flasher.ru (http://www.flasher.ru/forum/index.php)
-   ActionScript 3.0 (http://www.flasher.ru/forum/forumdisplay.php?f=83)
-   -   использование ASDoc (http://www.flasher.ru/forum/showthread.php?t=177898)

strangedk 11.04.2012 02:11

использование ASDoc
 
Скажите, ребята. Кто ставит комментарии в стиле ASDoc ?
В чем видите плюсы-минусы? И как комментарии ASDoc ведут себя в разных средах разработки?

Я например заметил, что FlashDevelop сам подставлял @param и @return, а в FlashBuilder всё приходится писать ручками.

В идеале видится подобная картина:
При разработке проекта, на все публичные методы, свойства и переменные обязательно ставить комментарии в стиле ASDoc.
И потом всё это можно собрать в виде документации.

ramshteks 11.04.2012 09:21

это javadoc стиль :) А вобще да, если вы хотите автоматическую документацию, то обязательно писать комментарии в таком стиле

Gaen 11.04.2012 11:51

Хочу примочку к компилятору, чтобы выдавала ворнинги на отсутствующие asdoc-комменты!

ramshteks 11.04.2012 11:53

юзайте intelli jidea, там в случае неправильного формата комментариев(только правда в случае их наличия) и даже отстутсвия пояснения, что это за возвращаемы или передаваемый параметр выдается ворнинг. Ну по крайней мере java версия поддерживает эту фичу

Inet_PC 11.04.2012 12:01

Цитата:

а в FlashBuilder всё приходится писать ручками
Ctrl+Shift+D генерит комментарий с @return и @param

strangedk 11.04.2012 12:08

Inet_PC, спасибо за подсказку. Облегчило жизнь.

ramshteks. Мне не сильно понравилась Idea, но я обещаю что разберу её более подробно :)

ramshteks 11.04.2012 12:14

strangedk, имеет очень мощные инструменты для рефакторинга. Поэтому обязательно поинтересуйтесь

strangedk 11.04.2012 12:18

А в чем проявляется "мощность" ?
Насколько я помню, тот же FB тоже умеет рефакторинг

ramshteks 11.04.2012 13:22

на счет FB не скажу. Но idea умеет очень много. Например перенос класса из одного пакета в другой не будет очень болезненным, так как idea автоматом изменит пакейдж внутри класса и все importы во всех классах которые ссылаются на переносимый класс. Я сравниваю с FlashDevelop, так как там механизмы для рефакторинга мягко говоря убогие.
Хотя все равно сижу на FD, так как он очень легкий. В отличии от idea, которая в плане памяти очень прожорливая.

strangedk 11.04.2012 13:31

То что вы описали, переименование чего-либо, и перенос файлов - умеет и FB, правда он всё равно кривой.
Я сам больше люблю FD, но многие проекты требуют FB.

- но в Idea разберусь, всё же


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

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