Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 3.11 KB

constants.md

File metadata and controls

51 lines (34 loc) · 3.11 KB

Константы

Общие правила:

  • Все числа кроме 0 и 1 - выносим в константы, т.к. они могут совершенно неожиданно измениться - например размер НДС - и тогда мы сможем изменить значение только в одном месте, а не в каждом где оно используется.

  • Обозначаем константы используя ТОЛЬКО_ЗАГЛАВНЫЕ_БУКВЫ и символ подчеркивания, в качестве разделителя между словами.

Примеры правильного именования

  1. admin_settings - PATH_TO_ADMIN_SETTINGS

    1. Обозначил, что переменная хранит путь до файла с настройками администратора
    2. Применил правила стандартного именования переменных

  2. defaultConnectionName - DEFAULT_CONNECTION_NAME

    1. Применил правила стандартного именования переменных

  3. configEncrypted - PATH_TO_CONFIG_ENCRYPTED

    1. Обозначил, что переменная хранит путь до файла с закодированными настройками администратора
    2. Применил правила стандартного именования переменных

  4. sizes - SIZES

    1. Применил правила стандартного именования переменных

  5. settingsDataResource - PATH_TO_APP_SETTINGS

    1. Обозначил, что переменная хранит путь до файла с настройками приложения
    2. Применил правила стандартного именования переменных

  6. isXXX - IS_RUNNED_ON_XXX

    1. Обозначил, что переменная хранит информацию о том, запущенно ли оно в ОС XXX
    2. Применил правила стандартного именования переменных

  7. baseDirXXX - BASE_DIR_XXX

    1. Применил правила стандартного именования переменных

  8. pathToDB - PATH_TO_DB

    1. Обозначил, что переменная хранит путь до файла БД
    2. Применил правила стандартного именования переменных

  9. connectionToDBString - CONNECTION_DB_STRING

    1. Применил правила стандартного именования переменных

  10. DEFAULT_TOP_VALUE

    1. Вынес число определяющее дефолтное значение для параметра - в константу.

  11. DEFAULT_SKIP_VALUE

    1. Вынес число определяющее дефолтное значение для параметра - в константу.

  12. COUNT_PARTS_FOR_URL

    1. Число элементов, которое перейдет в новый URL