Онлайн генератор документации для Node.JS проектов

[akzhan]

Очень рад появлению вашего проекта.

Большое спасибо. Как только в markdown-js внедрят поддержку GFM, начну использовать!

[1602]

Можно им помочь внедрить GFM, действительно нужная фича ;)

[akzhan]

Завтра интегрирую работу @gjtorikian и отправлю PRq (см. github.com/evilstreak/markdown-js/issues/41).

[1602]

пока пробую этот форк: github.com/isaacs/github-flavored-markdown
работает ок

[akzhan]

Блина, я уже начал править markdown-js. Спасибо за ссылку, тоже на него перейду :)

[Mithgol]

Что означает сокращение GFM?

[BVadim]

GitHub Flavored Markdown github.github.com/github-flavored-markdown/

[1602]

github.com/isaacs/github-flavored-markdown

npm install github-flavored-markdown

попробовал заинтрегрировать — выглядит неплохо, надо проверить на большем числе проектов, может на него и перейдем.

[Sannis]

Жаль пулл-реквест висит год без комментов.

P.S. Это я так пессимизирую на тему социальности гитхаба :)

[JiLiZART]

js

[1602]

Как насчет такого преимущества, что документации может и не быть для того, чтобы проект был успешно распарсен? В этом случае может быть получена оценка покрытия документацией — цифра которая должна прибавить мотивации документировать проект.

Ну и в догонку, хоть я и не использовал Doxygen, зайдя на их сайт понял что не так-то просто будет это сделать. А тут идея такая, что лишних телодвижений не надо — один GET, и получи документацию.

[4elentano]

Всё хорошо, только вот разработчиков на нод не сыщешь. Коммунити вокруг этого ф-ка действительно не хватает.

[1602]

Комьюнити есть! Твиттер, гуглогруппы и гитхаб довольно активны. Сказать по правде, я ожидал большего хабр-эффекта. После ретвита @tjholowaychuk гугланалитикс показывал под сотню посетителей единовременно, а сейчас — макс 20. Видимо тема nodejs не сильно популярна среди хабражителей :)

Но на гитхабе и в группах приходится общаться много, и надо отдать должное комьюнити — в основном разработчики очень отзывчивы.

[Sannis]

Этот инструмент можно использовать не только для документирования Node.js проектов.

[akzhan]

Да ладно? Может, условия вакансии не ахти? Есть, кстати, неплохая группа в Facebook, — MoscowJS.

[4elentano]

Условия нормальные. Большинство задает вопрос: «А че это?». А разработка под мобильные еще больше сужает круг поиска. За ссылку спс, пошукаем. Мб еще есть какие ресурсы? Желательно на русском.

[Sannis]

Значит нужно не искать готовое, а вкладывать. Просто так хорошие разработчики не появляются даже на перспективных направлениях. Разработчики находят место, где им будет комфортно и будет удобно учиться, и не часто его меняют.

[4elentano]

Полностью согласен. Но в моем случае при поиске на удаленку в интересный проект с хорошей оплатой даже вариантов нет. Может быть не там ищу просто) Ладно, не будем оффтопить.

[TheShock]

А хорошая оплата — это сколько?

[4elentano]

Оплата сдельная, есть ТЗ. Если интересно, могу скинуть.

[AndrewStephanoff]

Раньше использовал jsdoc-toolkit

[Sannis]

Планируете ли вы использовать этот генератор для других языков?

[akzhan]

А зачем? Для Ruby естественен YARD или Tomdoc.

Другое дело, что нужна поддержка C extensions.

[Sannis]

Да, я в основном о них.

Думаю вы помните историю со взлётом Dox и знаете чем он закончил в итоге. Так что продолжаю вынашивать эту мысль.

P.S. На самом деле, думаю что можно организовать всё это дело так, чтобы можно было поддерживать любой язык. Тем более что кроме расширений есть ещё и кофескрипт.

[1602]

Можно попробовать расширить для C, в принципе, не знаю только, есть ли смысл. Думаю, пока надо добиваться лучшего результата для js, а там видно будет.

[1602]

А что за история с dox? Раньше оно вроде как html отдавало, а теперь только json. Это видимо отголоски тех событий?

[Sannis]

Кстати, если генератор станет умнее, возможно стоит попробовать объединиться с startic.kr/njs, авто как раз планирует делать генерацию документации там.

[1602]

Поумнеть генератору поможет фидбэк в виде проектов на которых в настоящий момент не очень адекватный результат. К сожалению не все в моих силах. Например, в случае с backbone.js может справиться только docco, потому что там такая архитектура файла.

Кстати, проект переехал на jsdoc.info

[Sannis]

С поддержкой C/C++ я поколдую на днях, уже повесил себе тикет. И хотелось бы чуть большей настраиваемости, чтобы не только lib подсвечивать. Я тогда эти мысли на гитхабе уже изложу, а не здесь.