Специальные приемы комментирования в коде — полезность TODO, FIXME и XXX
- TODO: Вещи, до которых я еще не дошел
- FIXME : Known-broken code here
- HACK : Adimittedly inelegant solution to a problem
- XXX : Danger! Major problem here
TODO: + Описание: Если в коде есть эта метка, это означает, что на метке должен быть написан код функции, и функция, которая будет реализована, будет кратко объяснена в описании.
ИСПРАВЛЕНИЕ: + Описание: Если в коде есть эта идентичность, нужно исправить идентификационный код, даже код неверный, не работает, нужно исправить, как исправить будет упрощено в описании.
ХХХ: + Описание: Если в коде есть эта отметка, это означает, что хотя код под отметкой реализовал функцию, метод реализации еще обсуждается, и есть надежда, что в будущем его можно будет улучшить, и области, которые необходимо улучшенный будет кратко объяснен в описании.
Вы должны научиться хорошей практике программирования, чтобы писать js-код
Вы должны научиться хорошей практике программирования, чтобы писать js-код
- Обработка исключений
- обработка событий
- Изолировать логику приложения. Отделение логики приложения от всех обработчиков событий — лучший подход, потому что вы не знаете, когда та же часть логики сработает в следующий раз.
- Отправка объектов запрещена: поскольку логика приложения и обработчики событий полностью изолированы, в приложении не может быть кода, связанного с событием, поэтому логика приложения не может полагаться на объект события для функции.
- Определение модуля регистрации событий: Целая эпоха выступает за унифицированное модульное управление кодом JS, поэтому для облегчения управления нам необходимо определить модуль регистрации событий, чтобы унифицировать регистрацию (привязку) и удаление события.
- Разделение конфигурации
Нам необходимо извлечь элементы конфигурации и определить их в модуле конфигурации Config. (Вам нужно настроить модуль конфигурации Config самостоятельно, поэтому код не нужно демонстрировать...)
- единственная ответственность
Код должен выполняться по одной задаче за раз
- Точная конкретная номенклатура
Имена переменных должны содержать больше информации, избегайте общих слов (tmp->tmp_file). Именование логических переменных, обычно добавление is, has, can, should к логическим переменным может сделать значение более понятным.
- Примечания - Запишите свои мысли
- Комментарии должны документировать результаты ваших размышлений о том, как должен быть написан код.
- Может также использоваться для документирования процессов и констант.
- Когда кто-то читает ваш код, вы должны прокомментировать ту часть, которая вызывает у него сомнения.
- Объясните возможные ловушки (вы можете использовать некоторые хаки в процессе написания кода, или есть другие ловушки, о которых знают люди, которым нужно читать код)
- Упрощение циклов и логики
Пусть условные операторы, петли и другой контрольный код потока максимально естественны, так что читатели в процессе чтения не нужно приостановить, чтобы подумать или посмотреть на спину, является целью этого раздела.
- Положительная логика сначала наступает, например, если (Debug) лучше, чем если (! Debug)
- Сначала простая логика, чтобы if и else можно было отобразить на одном экране - сначала интересная, понятная логика
- Для условий, которые не выполняются, возвращайтесь как можно скорее, что может прояснить логику (возвратите как можно раньше, используйте continue в цикле).