Описание тега code-conventions

Описание тега Вопросы с тегом
Соглашения о коде - это рекомендации того, что разработчик должен и чего не должен делать при создании кода. Они могут основываться на личных предпочтениях, лучших отраслевых практиках, требованиях проекта или некотором процессе рассуждения. Организованный набор кодовых соглашений известен как стандарт кода.

Соглашения о коде являются основными элементами документов стандартов кода. Они защищают то, что разработчик должен и не должен делать. Их сфера действия варьируется от стилистических и синтаксических руководств до поощрения или предотвращения использования определенных функций языка программирования или библиотеки и даже до принятых методологий и инструментов разработки. Не существует общего происхождения для соглашений кода. Они могут отражать личные предпочтения, основанные на лучших отраслевых практиках, следствии навязанных требований к проекту или результате некоторого процесса рассуждения.

Учитывая широкую сферу применимости соглашений о коде, нередко их классифицируют по категориям, более точным областям действия их руководств. Примеры таких категорий включают в себя:

  • Соглашения об именах,
  • Комментарии и документация,
  • Стиль и форматирование,
  • Выражения и заявления,
  • Декларации и определения,
  • Функции и вызов функций,
  • Обработка ошибок,
  • Тестирование и проверка,
  • Инструменты разработки и
  • Устаревание кода.