Этот документ описывает единый стиль кода, разработанный командой RSDN, предназначенный прежде всего для проектов RSDN, но полезный всем, кто ищет удобный стиль форматирования исходного кода. Примеры даются на C#, но правила применимы и к другим языкам с учётом их специфики. Рассмотрим девять общих правил написания красивого и понятного кода.
Читаемость важнее скорости написания
Код чаще читается, чем пишется. Не экономьте на понятности и чистоте кода ради скорости набора. Избегайте коротких и непонятных имён, а также магических чисел. Иногда лучше сделать код менее выразительным и компактным в угоду его понимания.
Избегайте малопонятных префиксов и суффиксов
Не используйте малопонятные префиксы или суффиксы (например, венгерскую нотацию). Современные языки и средства разработки позволяют контролировать типы данных на этапе разработки и сборки. Венгерская нотация (например, btn для переменной типа Button) теряет актуальность.
Используйте стиль именования CamelCase или PascalCase
Не используйте подчеркивание для разделения слов внутри идентификаторов. Это удлиняет идентификаторы и затрудняет чтение. Используйте стиль именования CamelCase или PascalCase.
Избегайте лишних сокращений
Старайтесь не использовать сокращения. Помните о тех, кто читает ваш код.
Короткие, но понятные имена идентификаторов
Делайте имена идентификаторов как можно короче, но не в ущерб читабельности. Современные языки позволяют формировать имя из пространств имён и типов. Главное – понятный смысл в контексте. Например, Count лучше, чем CountOfElementsInMyCollection.
Избегайте конфликтов со стандартными идентификаторами
Придумывая название для общедоступного (public) класса, пространства имён или интерфейса, избегайте имён, потенциально или явно конфликтующих со стандартными идентификаторами.
Ясные и чёткие имена
Используйте имена, которые ясно и чётко описывают предназначение и/или смысл сущности.
Разные имена для разных сущностей
Не используйте для разных сущностей имена, отличающиеся только регистром букв. Ваши компоненты могут использоваться из языков, не различающих регистр, и некоторые методы (или весь компонент) могут оказаться недоступными.
Простота написания и произношения
Используйте имена с простым написанием. Их легче читать и набирать. Избегайте (в разумных пределах) слов с двойными буквами, сложным чередованием согласных. Убедитесь, что имя легко пишется и однозначно воспринимается на слух. Если оно с трудом читается или вы ошибаетесь при его наборе, выберите другое.
Придерживаясь этих правил, вы сможете писать более чистый, понятный и поддерживаемый код.