Некоторые основные правила оформления кода в сообществе программистов:
- Правила именования переменных и функций. 1 Учитываются регистр и использование символов подчёркивания. 1
- Стили отступов. 1 Учитывается количество пробелов в отступах, в аргументах функций, в операциях и других частях кода. 1
- Способ расстановки фигурных скобок. 1 Они могут располагаться с новой строки или на той же, рядом с конструкцией. 1
- Стиль и формат комментариев к коду. 1 Комментарии должны быть максимально наглядными и отражать суть: что делается и каков ожидается результат. 3
- Единообразие и структурированность кода. 5 Важно, чтобы каждая опция или каждый метод выполняли одну задачу. 5
- Избегание излишних комментариев. 5 Их не должно быть слишком много, комментарии даются лишь там, где это необходимо. 5
В рамках проекта или организации важно, чтобы все участники придерживались одного и того же стандарта оформления кода. 1 В этом случае команде будет проще поддерживать и дорабатывать существующий код. 1