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

Вернуться   Форум Flasher.ru > Flash > Общие вопросы о Flash (не затрагивающие ActionScript)

Версия для печати  Отправить по электронной почте    « Предыдущая тема | Следующая тема »  
Опции темы Опции просмотра
 
Создать новую тему Ответ
Старый 08.10.2012, 16:21
Srednas вне форума Посмотреть профиль Отправить личное сообщение для Srednas Найти все сообщения от Srednas
  № 1  
Ответить с цитированием
Srednas

Регистрация: Nov 2010
Сообщений: 430
По умолчанию Комментирование кода

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

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

Старый 08.10.2012, 16:22
-De- вне форума Посмотреть профиль Отправить личное сообщение для -De- Найти все сообщения от -De-
  № 2  
Ответить с цитированием
-De-
 
Аватар для -De-

блогер
Регистрация: Oct 2005
Адрес: Днепродзержинск - город Брежнева и других логопедов
Сообщений: 1,421
Записей в блоге: 4
Отправить сообщение для -De- с помощью ICQ Отправить сообщение для -De- с помощью Skype™
Гугли asdoc
__________________
Бобры отвечают на вопросы не потому, что знают на них ответы; они отвечают потому, что их спрашивают.

Старый 08.10.2012, 17:53
in4core вне форума Посмотреть профиль Отправить личное сообщение для in4core Найти все сообщения от in4core
  № 3  
Ответить с цитированием
in4core
[+4 06.05.14]
 
Аватар для in4core

Регистрация: Mar 2009
Сообщений: 4,219
Записей в блоге: 14
Srednas пользуясь флеш девелопом , смотри примеры документирования стандартных флеш классов , точно так же описываешь свои , param там @ и т.п. Далее подключаешь asdoc - генерится документация
__________________
Марк Tween

Старый 09.10.2012, 11:47
Frost47rus вне форума Посмотреть профиль Отправить личное сообщение для Frost47rus Найти все сообщения от Frost47rus
  № 4  
Ответить с цитированием
Frost47rus
[+4 08.09.13]

Регистрация: May 2012
Сообщений: 131
в фд комментарий к функе или параметру - пишется /**
и нажимается пробел
FD автоматом проставит следующие строки со знаками - останется только их заполнить

Старый 09.10.2012, 12:24
caseyryan вне форума Посмотреть профиль Отправить личное сообщение для caseyryan Найти все сообщения от caseyryan
  № 5  
Ответить с цитированием
caseyryan
 
Аватар для caseyryan

Регистрация: Jun 2012
Адрес: Новосибирск
Сообщений: 6,644
Записей в блоге: 4
Цитата:
и нажимается пробел
enter, если быть точнее

Старый 08.11.2012, 04:19
blanzh вне форума Посмотреть профиль Отправить личное сообщение для blanzh Найти все сообщения от blanzh
  № 6  
Ответить с цитированием
blanzh

Регистрация: Oct 2010
Сообщений: 26
возможно немного не в тему, но... Существуют аналоги asdoc, генерирующие доку похожую на оф. справочник AS3?
Нашел rich-docs, но не пользовал, т.к. денег просит.

Старый 08.11.2012, 04:35
wvxvw вне форума Посмотреть профиль Отправить личное сообщение для wvxvw Найти все сообщения от wvxvw
  № 7  
Ответить с цитированием
wvxvw
Modus ponens
 
Аватар для wvxvw

модератор форума
Регистрация: Jul 2006
Адрес: #1=(list #1#)
Сообщений: 8,049
Записей в блоге: 38
Вместе с Flex SDK в комплекте идет утилита asdocs с ее использованием и генерировалась справка (та что на сайте Адоби, да и вообще многих, кто публикует справку по AS коду).
http://www.flasher.ru/forum/showthread.php?t=137989
В прикрепленной теме есть несколько ссылок на описание работы утилиты.
Если, по каким-то причинам, работа утилиты не устроила, относительно хорошая поддержка есть у NaturalDocs. Если сравнивать полученные результаты от того и от другого - ASDocs, в какой-то степени надежнее (проверено на шкуре других ). Известны баги и как бороться. NaturalDocs мало известна в мире флеша, но вобщем-то хорошо зарекомендовавшая себя утилита в других областях.
HTML на выходе у NaturalDocs получается не в пример красивше.
Когда-то был такой человек известный во флешевом мире по имени senocular, он написал то ли утилиту, то ли расширение к утилите для тех же целей. Кажется называлось ZenDoc. Но почти наверняка проект зачах и не поддерживается.
__________________
Hell is the possibility of sanity

Создать новую тему Ответ Часовой пояс GMT +4, время: 15:10.
Быстрый переход
  « Предыдущая тема | Следующая тема »  

Ваши права в разделе
Вы не можете создавать новые темы
Вы не можете отвечать в темах
Вы не можете прикреплять вложения
Вы не можете редактировать свои сообщения

BB коды Вкл.
Смайлы Вкл.
[IMG] код Вкл.
HTML код Выкл.


 


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


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