Comments 6
Имхо, слишком поверхностно.
Как только нужно описывать сложные кейсы мы упираемся в не очень хорошую документацию. На ревью корректность сходу не проверишь. И нужно, чтобы каждый в команде научился их писать правильно. А ещё - поддержка и детальность описания.
Много усилий не нужно, чтобы научиться писать комментарии JSDoc. На ревью это проверяется также, как и всë остальное. Детальность описания может быть заранее утверждена командой. Например, у функций описываются только параметры и возвращаемое значение. Сложные кейсы описываются в руководствах + можно добавить storybook.
Mark up не пробовали? Это уже стандарт!
При написании руководств JSDoc можно использовать markdown.
можно подробнее?
Sign up to leave a comment.
Генерация документации с использованием JSDoc