2 года блогу: пишем понятный код

В списке самых популярных тем в этом году - Direct 2D и RTTI. Если первое изучалось только ради интереса, то второе принесло и практическую пользу в работе. Сейчас в статьях наблюдается явный перерыв, связан от части с тем, что для блога создается новый сайт, что, конечно, требует времени. Ну а помимо того, что у нас день рождения, хотелось бы попутно задеть одну простую тему - качества кода. Качество можно рассматривать с нескольких позиций. Конечно же первое место наверное стоит отдать такой составляющей, как знание языка и умение грамотно его применять. Но не только это важно. Качественный код должен быть простым, ясным, и легким для понимая. Особенно остро такой вопрос встает при передаче кода от одного человека к другому, либо же просто, когда вы заглядываете в свой код по прошествии длительного времени. В этом ключе можно так же рассматривать несколько аспектов:

1. Форматирование кода. Хороший код всегда должен быть хорошо структурирован, иметь отступы, пробелы, соблюдение регистра символов в наименованиях, группировать однотипные блоки (в регионы например) и т.п. В том числе иметь единый стиль в рамках всего проекта. Здесь впрочем может помочь встроенный форматтер кода, правда и он не идеален.
2. Второе - понятность используемых имен. Если имена ваши переменных/методов/классов не говорят сами за себя, то разобраться в таком коде будет очень не просто, даже если он написан с глубоким знанием языка, и имеет отличное форматирование.

если первый нюанс быстро исправляется, то чтобы исправить второй нужно сначала действительно понять для чего нужен класс/метод и т.п. А зачастую такое непонимание приводит к дальнейшему усложнению. Главное, что должен позволять делать код (в смысле его понятности), он должен быть таким, чтобы его нужно было не разбирать, а читать. Именно читать, как инструкцию. А чем инструкция проще, чем легче ее читать. Иногда, если вы не особо владеете языком, на котором написан код, вам сложно его и читать, и использовать. Т.е вы понимаете конструкцию как бы по частям, и не видите всей картины целиком. И это конечно влияет на то что вы в пишите, или не замечаете недостатков. Как вы наверное знаете, со времен Delphi 2009 существует возможность использовать русский язык в коде для имен. Поэтому для интереса, давайте рассмотрим небольшой пример русскоязычного кода. Как и принято будем руководствоваться правилами именования, но переиначим их. В нашем случае префикс класса - К, записи З, член/поле/переменная класса П. Для начала введем базовый класс, всего с парой методов:

    КОбъект = class(TObject)
      public
        constructor Создать();
        procedure Освободить();
    end;

а теперь опишем какой-нибудь класс наследник, например, пользователь:

    КПользователь = class(КОбъект)
      strict private
        ПИмя : string;
        ППароль : string;
        ПАвторизован : boolean;
      public
        procedure ЗапроситьАвторизацию(имяПользователя, парольПользователя : string);

        property Имя : string read ПИмя;
        property Авторизован : boolean read ПАвторизован;
    end;

    ИОшибкаАвторизации = class(Exception)
      private
        ППричина : string;
      public
        property ПричинаОшибки : string read ППричина;
    end;

и вариант использования этого кода:

var п : КПользователь;

begin
    п := КПользователь.Создать();
    try
        try

            п.ЗапроситьАвторизацию('ter', '...');
            if п.Авторизован then
                 writeln('hello', п.имя)
            else writeln('не верно указааны имя или пароль');

        except
            on и: ИОшибкаАвторизации do
                writeln(и.ПричинаОшибки););
        end;
    finally
        п.Освободить();
    end;
end.

Теперь программа превращается не в какой то код, а в действительно инструкцию:

1. Создать пользователя
2. Запросить авторизацию пользователя
3. Если пользователь авторизован то п.4.
4. Поприветствовать пользователя по имени
5. в исключительном случае, вывести причину ошибки
6. освободить пользователя

Я вас естественно не призываю писать на русском языке (: ибо это жесть какая то (: Но чем часто грешат начинающие программисты, это написания кода наподобие следующего (грубо говоря)

if (x = true) then сделатьЭто
else СделатьТо;
//или
if (x > 0 ) then  параметрПоложителен := true
else параметрПоложителен := false

А когда мы начинаем именно _читать_ код, то видя что-то вида "Если пользователь авторизован равно истина", сразу обращаешь внимание: зачем мне "авторизован равно истина", если я могу просто написать "если пользователь авторизован то.." Либо "Если икс строго больше нуля то параметрПоложителен равно истина, иначе параметрПоложителен равно Ложь", сразу же превратится в "параметрПоложителен := (x > 0)". На этой оптимистично ноте, заканчиваем заметку (: