Skip to main content

101

Основные правила​

Регистр​

Регистр (Case) - это способ записи букв в слове. В языках программирвания обычно запрещено использовать пробелы в именах переменных, поэтому для разделения слов в именах переменных используются различные регистры.

  • Camel Case (ВерблюжийРегистр) - это способ записи слов в именах переменных, при котором первое слово начинается с маленькой буквы, а каждое последующее слово начинается с большой буквы. Пример: myVariableName
  • Snake Case (ЗмеиныйРегистр) - это способ записи слов в именах переменных, при котором слова разделяются символом подчеркивания (_). Пример: my_variable_name
  • Kebab Case (КебабРегистр) - это способ записи слов в именах переменных, при котором слова разделяются дефисом (-). Пример: my-variable-name

Так же стоит упамянуть нижний регистр (lower case) и верхний регистр (upper case), в первом случае все буквы в слове записываются маленькими буквами, во втором - большими.

Константы обычно записываются в верхнем регистре с использованием символа подчеркивания для разделения слов. Пример: MY_CONSTANT_NAME

Комментарии​

Комментарии (Comments) - это специальные инструкции, которые используются для описания кода. Комментарии не выполняются компьютером, они используются только для описания кода программы. Комментарии могут быть однострочными или многострочными.

С их помощью можно описать, оставить заметку, объяснить код, а так же исключить код из выполнения.

Однострочные комментарии​

Однострочные комментарии (Single-line comments) начинаются с двойного косого слэша (//). Все, что находится после двойного косого слэша, считается комментарием и игнорируется компьютером.

// Это однострочный комментарий

Как называть файлы и папки​

  • Имена файлов и папок должны быть осмысленными и описывать их содержимое
  • Имена файлов и папок должны быть на английском языке
  • Имена файлов и папок не должны содержать пробелы, специальные символы и русские буквы
  • Имена файлов и папок должны быть короткими и легко читаемыми
  • Не следует сокращать имена файлов и папок без крайней необходимости
  • Следует использовать дефис (-) или нижнее подчеркивание (_) для разделения слов в именах файлов и папок, если иного не предусмотрено стандартом языка.
  • Используйте нижний регистр (lower case) для имен файлов и папок если иного не предусмотрено стандартом языка.
  • Создавайте отдельные папки для каждого проекта даже если проект состоит из одного файла, вы можете создавать папки по типу lesson_1, lesson_2 и т.д. главное чтобы папки были отдельными и имели осмысленное название.

Стайлгайды​

Руководство по стилю (Style guides) - это набор правил, которые определяют, как должен быть оформлен код программы. Руководство по стилю включает в себя правила по именованию переменных, отступам, комментариям и т.д. Руководство по стилю помогает сделать код программы более читаемым и понятным.

Стайлгайды на английском языке​

Стайлгайды на русском языке​

Многострочные комментарии​

Многострочные комментарии (Multi-line comments) начинаются с косой черты и звездочки и заканчиваются звездочкой и косой чертой. Все, что находится между косой чертой и звездочкой и звездочкой и косой чертой, считается комментарием и игнорируется компьютером.

/*
Это
многострочный
комментарий
*/