20 советов по созданию настоящего Х-кода (часть II)

Xakep, номер #038, стр. 038-067-3

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

Совет #6

При объявлении или присвоении начальных значений большому количеству переменных записывай их в алфавитном порядке, например:

Dim BlueBoy As Integer

Dim CowBoy As Double

Dim DeadBoy As Currency

BlueBoy = 0

CowBoy = 1

DeadBoy = -1

Совет #7

Не скупись на пробелы! Ты должен понимать, что чем больше свободного пространства на экране, тем легче человеческому глазу различать текст. Соответственно, чтобы было легче читать код, вставляй пустые строки до и после каждого более-менее значащего блока кода. Т.е. выделяй пустыми строками процедуры, функции, структуры (инструкции) и т.д. и т.п. Ставь пробел после каждой запятой и выделяй пробелами бинарные операции, такие, как: +, -, * и т. п., если, конечно, твой редактор кода не делает это автоматически (может быть, ты пишешь свой код в «Блокноте»).

Совет #8

Используй «лесенку», т.е. записывай с отступом операторы тела блоков кода. Например:

begin

...

begin

...

begin

...

end;

...

end;

...

end;

Но большая глубина вложенности может сделать программу трудной для понимания, поэтому старайся избегать более трех уровней отступов. Также настоятельно советую делать отступы клавишей TAB, а не клавишей ПРОБЕЛ.

Совет #9

Учись грамотно использовать комментарии в своем коде. К сожалению, часто бывает, что кодеры либо совсем не используют комментарии, либо закомментируют так свою прогу, что трудно становится обнаружить код :(. Нужно учиться находить золотую середину! Необходимо комментировать только те участки текста, которые реально могут вызвать трудности в понимании. Чаще всего комментарии необходимо вставлять перед функциями и процедурами. Также хорошим тоном считается включать комментарий в начало кода, описывающего цель программы.

Совет #10

В дополнение к предыдущему совету: при создании структур типа условий, циклов и т.п. советую сразу обозначить комментарием замыкающее слово (end), чтобы потом не мучаться вопросом типа: «Чей это end?». Например:

while not EOF (Text) do

begin

...

if NumOne = NumTwo then

begin

...

if (NumThree < 0) and (NumFour > 1) and (NumFive <> 0) then

begin

...

end; // if (NumThree < 0)...

...

end; // if NumOne = NumTwo

...

end; // while not EOF (Text)

Как ты можешь заметить, такие комментарии создаются легко (и быстро) простым копированием заголовка структуры.

Совет #11

Старайся писать комментарии на одном уровне, как это сделано в предыдущем примере.

Совет #12

Не лепи несколько команд в одной строке, даже если язык это позволяет, например:

For i=1 To 10: Print i: Next i

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

Совет #13

Пиши строки так, чтобы они влезали по ширине экрана. Горизонтального скроллинга быть не должно! Если строка не влезает, делай переносы (если, конечно, язык программирования это позволяет), например: