alex4answ
@alex4answ

Почему js код мало документируют?

Добрый день, работаю с node (express и тп).

Все проекты которые встречал (REST API) документированы отдельным swagger.json файлом (сам js/ts код не содержит документации), почему почти не используется jsDoc для автоматической генерации?

Так же открывал исходники разных библиотек, все в TypeScript, но конкретной документации кода я не увидел.
Я пришел в мир JS из PHP, и там документируется почти каждый шаг, каждая переменная, метод, класс.
  • Вопрос задан
  • 144 просмотра
Решения вопроса 1
xmoonlight
@xmoonlight
https://sitecoder.blogspot.com
Документируются только сложные участки кода, сложная логика обработки/вычислений, особенные методы в классах и неявные (по коду) подписки на события.

Откройте код игрового "движка" на js или encrypt/hash-библиотеки на js, и сразу увидите коментирование кода в сложных (для понимания) местах.
Ответ написан
Комментировать
Пригласить эксперта
Ваш ответ на вопрос

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

Войти через центр авторизации
Похожие вопросы