Версия для печати темы Нажмите сюда для просмотра этой темы в оригинальном формате

Форум программистов > PHP: Общие вопросы > Авто документация. phpDocumentor + Javascript?

Автор: ksnk 21.1.2012, 21:55

Возникла надобность оформить документацию по приложению в нормальном виде, с описанием методов, функций и протч... Проблема в том, используемый мной phpDocumentor не желает понимать неPHP файлы, а  солидной и неотделимой частью в проект входит все многообразие web-файлов, включая js, css и посторонние экзотические утилиты. Так что в конечный пакет документации нужно включить и их. Нет ли системы, которая в едином стиле, примерно похожем на JavaDoc (phpDocumentor) позволяет оформлять описания функций прямо в коде, которая бы позволяла указывать разные типы файлов? И которая позволяла бы собирать их в единый документ Imho, надобность такой системы достаточно очевидна, однако поверхностное гугление результата не принесло.

Автор: Sentox 21.1.2012, 23:36

http://ru.wikipedia.org/wiki/JSDoc http://code.google.com/p/jsdoc-toolkit/

Автор: skyboy 21.1.2012, 23:41

отталкиваясь от http://en.wikipedia.org/wiki/Comparison_of_documentation_generators, рекомендую посмотреть те, которые заявлены как "Language support: Any With Comments"

Автор: ksnk 22.1.2012, 01:50

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 22.1.2012, 11:14

Natural Docs понимает JavaDoc ТОЛЬКО для своего списка "Full language support", который ограничен С#, ActiveScript и Perl. Остальные языки документятся в своем собственном формате...

Автор: Sentox 22.1.2012, 15:15

Цитата ~ Doc-O-Matic - есть триальная версия http://rutracker.org/forum/viewtopic.php?t=3387144 Надо бы и себе делать документацию, уже назрел вопрос. С Вашим постом это стало явней, спасибо!

Автор: skyboy 22.1.2012, 18:59

сорри за нетактичный вопрос, но почему бы и не заплатить за хороший инструмент?

Автор: ksnk 22.1.2012, 19:18

skyboy, Если на пару вопросов мне тамошний саппорт ответит, очень вероятно, что и куплю ;) К тому-же для версии 7, которая сейчас на сайте, ключики еще не сделаны ;) Пока я там нарыл один глюк. Русские комментарии в файлах конвертируются в утф8 еще один раз, так что получаются кракозябры. Решением будет преобразовать utf-8 файлы в кодировку win1251 перед обработкой документатором. Немного странно, что у него нет способа указать кодовую таблицу для разных файлов ( при том, что он сам определил русскую кодировку файла) но это для меня не очень большая проблема, все равно исходники для обработки мне нужно отдельно готовить...

Автор: ksnk 26.1.2012, 11:44

Еще одна проблема с DOC-O-MATIC. при генерации страницы и элементами класса сгенерировалась такая строка Цитата This is __construct, a member of pynff CercebprffGnfx.  вместо  Цитата This is __construct, a member of class PreprocessorTask.  Support молчит,  в форум пускают только честных покупателей, так что вероятносnь покупки (и использования вообще ) мной этого документатора уменьшается.

Автор: Gold Dragon 26.1.2012, 11:47

пытался разобраться с этим, но так и не понял как это работает и должно работать.. Может кто ссылку даст на обучение какое-нибудь, только на русском

Автор: ksnk 26.1.2012, 15:33

Цитата(ksnk @  26.1.2012,  11:44 ) member of pynff CercebprffGnfx Саппрот объявился, так что придется покупать.    Как мне объяснили - это такая специальная фича для триального ключа. Причем, 6-ка с рутрекера ведет себя точно так же. Так что халява не пройдет  Gold Dragon, Надо учить английский. Мой скилл пока не особо силен + судя по всему - без честной лицензии не получится попользоваться. На выходные попробую посерьезнее разобраться с документатором, возможно, смогу ответить на какие нибудь вопросы.

Автор: Gold Dragon 26.1.2012, 19:56

Цитата(ksnk @  26.1.2012,  16:33 ) Gold Dragon, Надо учить английский.  я его знаю и могу общаться. Но вот понимать технические моменты иногда тяжело.. Тут на русском иногда трудно понять смысл когда "с нуля" учишь...

Powered by Invision Power Board (http://www.invisionboard.com)
© Invision Power Services (http://www.invisionpower.com)