Мы живем с обилием библиотек, фреймворков и расширений, таких как React, Redux и TypeScript. У нас также есть различные принципы программирования, такие как DRY, KISS, SOLID и YAGNI. Мы разрабатываем нашу архитектуру и оптимизируем код для обеспечения производительности, безопасности, масштабируемости, возможности обновления и ясности, часто без масштабируемой методологии.
Профессор из Кембриджа однажды сказал мне, что единственный человек, который мог писать прямо из своего воображения, — это Шекспир; всем остальным нужно тратить время на обработку, редактирование и передачу своих идей. То, что верно для университетских эссе, верно и для написания кода и комментариев к коду. Цель, намерение и аргументация могут быть сформулированы с помощью структуры комментариев. Вот несколько инструментов для этого:
- RFC 2119: общий словарь.
- JSDoc: язык разметки, используемый для аннотирования файлов исходного кода JavaScript.
- Руководство по стилю Google JavaScript: общий набор правил.
- ESLint: линтер кода для проверки правильности комментариев.
- ESDoc: подключаемый модуль, который автоматически создает шаблон документации по мере написания кода.
