Задать вопрос
zkrvndm
@zkrvndm
Архитектор решений

Как документировать код на JavaScript?

Предстоит сложный проект, который буду пилить в одиночку. Хотелось бы предусмотреть документацию на случай, если в будущем к проекту подключат еще кого-нибудь, чтобы коллега мог почитать мои каталогизированные заметки и сходу въехать во внутреннюю логику и архитектуру приложения.

Чтобы вы посоветовали для ведения документации? Не для хранения кода, а именно для ведения обычной текстовый документации в виде структурированных заметок.

P. S. Планирую сделать простой сайт на базе CMS Joomla и туда заливать все свои заметки, но может есть варианты получше? Писать всё в комментарии внутри кода не вариант, слишком много комментариев выйдет тогда) Да и примеры запросов к API так не приложишь.
  • Вопрос задан
  • 2196 просмотров
Подписаться 1 Простой Комментировать
Решения вопроса 2
IonDen
@IonDen
JavaScript developer. IonDen.com
Все придумали до нас: JSDoc
Ответ написан
delphinpro
@delphinpro Куратор тега JavaScript
frontend developer
Пилить сайт для документации излишне. Я бы воспользовался одним из онлайн-сервисов.
Какие есть сервисы для документации при разработке программ?
Плюс, как уже сказали можно использовать jsdoc для автогенерируемой документации.
Ответ написан
Комментировать
Пригласить эксперта
Ответы на вопрос 2
Посмотрите как делаются гайды, доки к библиотекам, фреймворкам, плагинам и т.п. на гитхабе например.
Ответ написан
WblCHA
@WblCHA
Предстоит сложный проект

Очевидно, что писать сложный проект на ЖСе не самая лучшая идея.
Пиши на typescript'e и понадобится намного меньше документации и въехать в проект можно будет намного проще и быстрее. Про упрощения поиска ошибок самому вообще молчу.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы