common.md

Общие

• Придерживайтесь стандартов кода и соглашений своего языка программирования

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

• Используйте .editorconfig

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

• Называйте все понятно

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

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