Форум Flasher.ru
Ближайшие курсы в Школе RealTime
Список интенсивных курсов: [см.]  
  
Специальные предложения: [см.]  
  
 
Регистрация Блоги Правила Справка Пользователи Календарь Поиск рулит! Сообщения за день Все разделы прочитаны
 

Вернуться   Форум Flasher.ru > Блоги > Бесполезности

обо всем по-немногу...
Оценить эту запись

ASDoc Comment Injector

Запись от cleptoman размещена 08.02.2011 в 23:30

наткнулся в сети на достаточно старую тему (потому для многоих, не исключено, это будет инфой не первой, скажем так, свежести)
Commentor

что делает - лопатит все классы по указанной директории -input
добавляет "рыбу" ASDoc коментариев к классам, методам и свойствам
и генерирует новые классы в -output. (хотя есть параметр перезаписи исходных классов, но для тестов чот я побоялся ее поюзать)

в общем-то, вся нужная ознакомительная информация есть в пруф-линке. расскажу немного о своих манипуляциях с этой програмулиной:
1 - распаковал.
2 - на базе любезной предоставленных BATников состряпал свой
3 - закинул его в темплейт проекта FD (pure AS3)
4 - создал проект. увидел свой батничек
5 - запустил батник

результатом, в общем доволен: есть готовая "рыба", по которой можно уже облагораживать код своими коментариями. готовить ASDoc.

что не понравилось: не коментит метатеги. не коментит дефолтные значения в аргументах методов.
ну это все навскидку.

тема - не исключено, что боян. Но, может, кому и пригодится.

прилагаю свой батник (некоторые аргументы из хелпа просто заменил обычной текстовкой в -info)
Код:
E:\commentor\commentor -info "@see http://cleptoman.free-lance.ru" -info "@author Aleksey Kutov aka cleptoman" -info "@langversion ActionScript 3.0" -input src\ -output asdoc_comm_injected\
pause
штука простая и не замысловатая )
Всего комментариев 11

Комментарии

Старый 09.02.2011 19:09 iNils вне форума
iNils
 
Аватар для iNils
Добавлю, что шаблон для метода в FD можно получить набрав перед ним /**. После чего выпадает контекстное меню в котором первый пункт позволяет сгенерировать шаблон с аргументами и return.
Старый 09.02.2011 19:16 cleptoman вне форума
cleptoman
 
Аватар для cleptoman
ага, спасибо.
Старый 10.02.2011 13:35 Hidest вне форума
Hidest
 
Аватар для Hidest
Полезна и статейка и дополнение про /**. Только с аксессорами не работает, поведение такое же как и Empty комментарий. Так и должно быть?
Старый 10.02.2011 13:54 iNils вне форума
iNils
 
Аватар для iNils
Да. Это же аксессор.
Старый 10.02.2011 14:41 gloomyBrain вне форума
gloomyBrain
 
Аватар для gloomyBrain
Можно добавить комменты к аксессорам через Tools -> ApplicationFiles -> Data -> ASCompleteion -> Generator.txt
Старый 10.02.2011 14:51 iNils вне форума
iNils
 
Аватар для iNils
Что там добавлять? Только описание. Там нет разного числа параметров, только всегда один для сета. Там фиксированные void и тип, для сета и гета. Там все стандартно, поэтому описывается только само свойство. Все остальное доставляет ASDoc.
Старый 10.02.2011 15:02 cleptoman вне форума
cleptoman
 
Аватар для cleptoman
вроде как геттер описывается, но не понятно как и что описывать, если у нас только сеттер, например)
Старый 10.02.2011 15:08 iNils вне форума
iNils
 
Аватар для iNils
Там не важно, что описывается, геттер или сеттер. Описание одно на всех. Просто будет read-write, only read или only write.
Старый 10.02.2011 15:36 gloomyBrain вне форума
gloomyBrain
 
Аватар для gloomyBrain
Цитата:
Что там добавлять? Только описание
Ну да. Я себе и добавил @private для сеттеров и пустой блок под описание для геттеров

Цитата:
если у нас только сеттер, например
Это странная ситуация - зачем тогда вообще аксессоры? Я бы при таком раскладе делал метод setValue(value:*)
Старый 10.02.2011 16:42 iNils вне форума
iNils
 
Аватар для iNils
Цитата:
Это странная ситуация - зачем тогда вообще аксессоры?
Это вполне нормально, хотя и редко встречается. Например для fps класса SharedObject.
Старый 10.02.2011 23:54 dimarik вне форума
dimarik
 
Аватар для dimarik
 

 


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


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