| Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате |
| Форум программистов > Системный анализ, проектирование и UML > ПРограмма, помогающая писать хелп |
| Автор: szz 21.8.2006, 07:07 | ||
| Я вот щас на флеше пишу свою иерархию классов, и мне нужно днлать для них доку, так как растет система, всего не упомнишь... Мне нужна программа, в которой я бы мог нормально писать хелп. Каждый класс, как обычно имеет методы, свойства и события. Т.е. соответственно нужная программа должна давать мне возможность вписывать это все в заранее подготовленном шаблоне. Т.е. примерно так:
И после того, как я инфу загнал, чтоб можно было сгенерить HTML хелп с навигацией по всему хелпу (генерация других фотматов типа chm приветствуется, но необяз) |
| Автор: Се ля ви 21.8.2006, 20:02 |
| На Flash`е сложную иерархию классов? Не знаю, как тебе помочь, Macromedia явно недостаточно работает над своим продуктом, по крайней мере не рассчитывает, что кто-то будет его использовать для написания сложной иерархии классов, если не ввела документирующих комментариев как раз для таких задачь. На Java, например, всё это есть, у нас это "Javadoc" называется - просто перед классами и методами ставишь специального вида комментарии и потом специальная утилита штудирует твои исходники и составляет по ним описание в HTML`ном стандартном виде - очень удобно. Можно ещё свои доклеты писать, но это уже Advanced-уровень... Посмотри, может быть во Flash`е это уже на самом деле есть? Или кто-то уже такую штуку попытался реализовать кустарно и где-нибудь расшарил? Ну а если нет - повод подумать над тем, что бы заняться созданием этого дела для Flash`а самому, потому что прога, о которой ты говоришь, хоть и лучше, чем ничего, но вряд ли будет удобна... |
| Автор: szz 21.8.2006, 20:52 |
| Да, я знаком с javadoc, в PHP есть что-то подобное тоже - специально форматированные комменты, которые потом можно генерить во что угодно... Попробую написать сам. О процессе работы буду сюда сообщать - мож кому понадобится тоже ))) |