Практические занятия по курсу ОиМП/Группа 101 1/StyleGuide

Общее правило: все StyleGuide преследуют всегда на одни и те же две цели - избежать стандартных ошибок при проектировании и написании кода, а также повысить читаемость написанных программ.

Те правила, которые приведены ниже, вы можете найти почти в любом StyleGuide крупных компаний, отличаться будут разве что системы названия переменных и правила написания комментариев.

Названия

• Переменные и публичные поля структур называются с маленькой буквы, слова разделяются знаками подчеркивания: count_of_numbers, max_element, current_position.
• Приватные поля называются так же, но оканчиваются на дополнительный знак подчеркивания: efficiency_sum_, team_members_, next_.
• Функции и методы называются в CamelNotation, то есть каждое слово пишется с большой буквы, слова пишутся слитно: GetEfficiencySum, SetTeamName, BuildShortestWay.
• Классы называются в той же нотации, но начинаются с буквы C, если это класс, и S, если это структура: SPlayer, SPoint, CTeam, CPolygon.

Называйте переменные по их смыслу. Не сокращайте слова, это несильно уменьшает объем кода, но сильно снижает его читаемость.