![]() |
Модераторы: skyboy, MoLeX, Aliance, ksnk |
![]() ![]() ![]() |
|
ksnk |
|
|||
![]() прохожий ![]() ![]() ![]() ![]() Профиль Группа: Комодератор Сообщений: 6855 Регистрация: 13.4.2007 Где: СПб Репутация: 96 Всего: 386 |
Возникла надобность оформить документацию по приложению в нормальном виде, с описанием методов, функций и протч...
Проблема в том, используемый мной phpDocumentor не желает понимать неPHP файлы, а солидной и неотделимой частью в проект входит все многообразие web-файлов, включая js, css и посторонние экзотические утилиты. Так что в конечный пакет документации нужно включить и их. Нет ли системы, которая в едином стиле, примерно похожем на JavaDoc (phpDocumentor) позволяет оформлять описания функций прямо в коде, которая бы позволяла указывать разные типы файлов? И которая позволяла бы собирать их в единый документ Imho, надобность такой системы достаточно очевидна, однако поверхностное гугление результата не принесло. -------------------- Человеку свойственно ошибаться, программисту свойственно ошибаться профессионально ! ![]() |
|||
|
||||
Sentox |
|
|||
как то так ![]() ![]() Профиль Группа: Участник Сообщений: 392 Регистрация: 27.1.2009 Где: Зимбабве Репутация: 7 Всего: 7 |
||||
|
||||
skyboy |
|
|||
неОпытный ![]() ![]() ![]() ![]() Профиль Группа: Модератор Сообщений: 9820 Регистрация: 18.5.2006 Где: Днепропетровск Репутация: 75 Всего: 260 |
отталкиваясь от сравнения, рекомендую посмотреть те, которые заявлены как "Language support: Any With Comments"
|
|||
|
||||
ksnk |
|
|||
![]() прохожий ![]() ![]() ![]() ![]() Профиль Группа: Комодератор Сообщений: 6855 Регистрация: 13.4.2007 Где: СПб Репутация: 96 Всего: 386 |
Sentox, JSDoc не понимает php, или я его не смог уговорить. К тому-же стандартные темплейты документации показались мне ну очень убогими, даже по сравнению с phpDocumentor'ом
skyboy, Мои потребности - PHP+Javascript, JavaDoc комментарии, работа под windows. Из сравнения получилось, что могут подойти ~ Doc-O-Matic - есть триальная версия - HeaderDoc - подходящий мне по языкам, фришный, но сделан Apple и работает не под Виндой... ~ Natural Docs - фришный, но написан на Perl'е. Это не смертельно, но надо доставлять еще и ActivePerl. - ROBODoc - не Javadoc - TwinText - не фришный, не Javadoc - Universal Report - не фришный... Пока поковыряю Natural Doc, отпишусь как оно пойдет, посмотрю и на Doc-O-Matic, вдруг понравится... -------------------- Человеку свойственно ошибаться, программисту свойственно ошибаться профессионально ! ![]() |
|||
|
||||
ksnk |
|
|||
![]() прохожий ![]() ![]() ![]() ![]() Профиль Группа: Комодератор Сообщений: 6855 Регистрация: 13.4.2007 Где: СПб Репутация: 96 Всего: 386 |
Natural Docs понимает JavaDoc ТОЛЬКО для своего списка "Full language support", который ограничен С#, ActiveScript и Perl. Остальные языки документятся в своем собственном формате...
-------------------- Человеку свойственно ошибаться, программисту свойственно ошибаться профессионально ! ![]() |
|||
|
||||
Sentox |
|
|||
как то так ![]() ![]() Профиль Группа: Участник Сообщений: 392 Регистрация: 27.1.2009 Где: Зимбабве Репутация: 7 Всего: 7 |
http://rutracker.org/forum/viewtopic.php?t=3387144 Надо бы и себе делать документацию, уже назрел вопрос. С Вашим постом это стало явней, спасибо! Это сообщение отредактировал(а) Sentox - 22.1.2012, 15:17 |
|||
|
||||
skyboy |
|
|||
неОпытный ![]() ![]() ![]() ![]() Профиль Группа: Модератор Сообщений: 9820 Регистрация: 18.5.2006 Где: Днепропетровск Репутация: 75 Всего: 260 |
сорри за нетактичный вопрос, но почему бы и не заплатить за хороший инструмент?
|
|||
|
||||
ksnk |
|
|||
![]() прохожий ![]() ![]() ![]() ![]() Профиль Группа: Комодератор Сообщений: 6855 Регистрация: 13.4.2007 Где: СПб Репутация: 96 Всего: 386 |
skyboy, Если на пару вопросов мне тамошний саппорт ответит, очень вероятно, что и куплю ;) К тому-же для версии 7, которая сейчас на сайте, ключики еще не сделаны ;)
Пока я там нарыл один глюк. Русские комментарии в файлах конвертируются в утф8 еще один раз, так что получаются кракозябры. Решением будет преобразовать utf-8 файлы в кодировку win1251 перед обработкой документатором. Немного странно, что у него нет способа указать кодовую таблицу для разных файлов ( при том, что он сам определил русскую кодировку файла) но это для меня не очень большая проблема, все равно исходники для обработки мне нужно отдельно готовить... -------------------- Человеку свойственно ошибаться, программисту свойственно ошибаться профессионально ! ![]() |
|||
|
||||
ksnk |
|
||||
![]() прохожий ![]() ![]() ![]() ![]() Профиль Группа: Комодератор Сообщений: 6855 Регистрация: 13.4.2007 Где: СПб Репутация: 96 Всего: 386 |
Еще одна проблема с DOC-O-MATIC.
при генерации страницы и элементами класса сгенерировалась такая строка
вместо
Support молчит, в форум пускают только честных покупателей, так что вероятносnь покупки (и использования вообще ) мной этого документатора уменьшается. -------------------- Человеку свойственно ошибаться, программисту свойственно ошибаться профессионально ! ![]() |
||||
|
|||||
Gold Dragon |
|
|||
![]() Призрачный ![]() ![]() ![]() ![]() Профиль Группа: Экс. модератор Сообщений: 6753 Регистрация: 1.3.2004 Где: Россия, Тамбов Репутация: 10 Всего: 71 |
пытался разобраться с этим, но так и не понял как это работает и должно работать.. Может кто ссылку даст на обучение какое-нибудь, только на русском
-------------------- Нельзя жить в прошлом, оно уже прошло. Нельзя жить в будущем, оно ещё не наступило. Нужно жить в настоящем, помня прошлое и думая о будущем! |
|||
|
||||
ksnk |
|
|||
![]() прохожий ![]() ![]() ![]() ![]() Профиль Группа: Комодератор Сообщений: 6855 Регистрация: 13.4.2007 Где: СПб Репутация: 96 Всего: 386 |
Саппрот объявился, так что придется покупать. ![]() Как мне объяснили - это такая специальная фича для триального ключа. Причем, 6-ка с рутрекера ведет себя точно так же. Так что халява не пройдет Gold Dragon, Надо учить английский. Мой скилл пока не особо силен + судя по всему - без честной лицензии не получится попользоваться. На выходные попробую посерьезнее разобраться с документатором, возможно, смогу ответить на какие нибудь вопросы. -------------------- Человеку свойственно ошибаться, программисту свойственно ошибаться профессионально ! ![]() |
|||
|
||||
Gold Dragon |
|
|||
![]() Призрачный ![]() ![]() ![]() ![]() Профиль Группа: Экс. модератор Сообщений: 6753 Регистрация: 1.3.2004 Где: Россия, Тамбов Репутация: 10 Всего: 71 |
я его знаю и могу общаться. Но вот понимать технические моменты иногда тяжело.. Тут на русском иногда трудно понять смысл когда "с нуля" учишь...
-------------------- Нельзя жить в прошлом, оно уже прошло. Нельзя жить в будущем, оно ещё не наступило. Нужно жить в настоящем, помня прошлое и думая о будущем! |
|||
|
||||
![]() ![]() ![]() |
Правила форума "PHP" | |
|
Новичкам:
Важно:
Внимание:
Если Вам понравилась атмосфера форума, заходите к нам чаще! С уважением, IZ@TOP, skyboy, SamDark, MoLeX, awers. |
0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей) | |
0 Пользователей: | |
« Предыдущая тема | PHP: Общие вопросы | Следующая тема » |
|
По вопросам размещения рекламы пишите на vladimir(sobaka)vingrad.ru
Отказ от ответственности Powered by Invision Power Board(R) 1.3 © 2003 IPS, Inc. |