Оформление исходных текстов
Файл с функцией
mainдолжен называтьсяmain.c/main.cpp.Все исходники должны быть отформатированы с использованием
.clang-format, который будет лежать в репозиториях.Переменные/объекты должны объявляться как можно ближе к месту их фактического использования. Не плодите глобальные переменные без острой на той необходимости.
Недопустимо создавать поля/переменные/методы/функции, начинающиеся с подчеркиваний.
Все функции, структуры, методы, переменные и пр. в коде называется нормально, а не
void func(),int abcи пр.В конце файлов с кодом (заголовочных и исходников) должна быть пустая строка (no-newline-compile-warning).
Наиболее простым способом следовать этим правилам будет настроить редактор так, чтобы он выполнял такое форматирование автоматически. Общий признак хорошего кода: его можно прочитать по телефону и он будет понятен на той стороне.
Last updated