Максимы стиля кодирования
Рекомендации без лишних разговоров и объяснений.
- Правильно разделяйте свою программу на модули (файлы).
- Используйте автоматические средства форматирования кода для расстановки отступов и пробелов.
-
Имена
- Используйте содержательные имена переменных и функций.
- Фиксируйте свой написания сложных имен:
with_underscore
или camelCase
.
- Используйте директиву
#define
для задания символьных имен числовых констант.
- Символьные имена, введённые директивой
#define
, записывайте ЗАГЛАВНЫМИ буквами.
- Имя файла должно отражать его содержание.
- Имя заголовочного файла, в котором объявлены функции, должно совпадать с именем .c файла, где они реализованы.
- Избегайте глобальных переменных.
-
Длинна
- Размер одной функции не должен превышать трех экранов (70-100 строк).
- Большинство функций должно умещаться на одном экране.
- Не пишите строки длиннее 80 символов.
-
Комментарии
- Комментируйте сложные участки кода.
- Пишите документацию на все функции и модули.