Программирование на языке высокого уровня. Замятин А.В - 20 стр.

UptoLike

ВУЗ: 

ТПУ | Томск

Составители: 

Рубрика: 

20
Концепция грамотного программирования настаивает на включение в
текст программы настолько подробных и продуманных комментариев, чтобы
она стала исходным текстом не только для исполняемого кода, но и для со-
проводительной документации.
Время, потраченное на написание комментариев, многократно окупится
при любых модификациях программы. Однако комментировать все подряд,
включая самоочевидные действия, как в следующем примере, тоже не стоит:
size = 10; // Присвоить size значение 10
for( i=0; i < size; i++) // Цикл по i от 0 до size
{
. . .
}
Комментировать следует:
• заголовок файла, описывая содержимое данного файла;
• заголовок функции, поясняя назначение ее аргументов и смысл самой
функции;
• вводимые переменные и структуры данных;
• основные этапы и особенности реализуемых алгоритмов;
• любые места, которые трудны для быстрого понимания, в особенно-
сти использование различных программных "трюков" и нестандартных прие-
мов.
Некоторые комментарии программисты используют в ходе своей рабо-
ты. Подобные комментарии особенно полезны, когда над одним кодом рабо-
тает несколько разработчиков. Так, комментарием TODO обычно помечают
участок кода, который программист оставляет незавершённым, чтобы вер-
нуться к нему позже. Комментарий FIXME помечает обнаруженную ошибку,
которую решают исправить позже. Комментарий XXX или ZZZ обозначает
найденную критическую ошибку, без исправления которой нельзя продол-
жать дальнейшую работу.
Учет различных особенностей языка.
1. Скобки. Необходимо использовать скобки при описании арифметиче-
ских операций для избежания проблем с их обработкой. Даже если оператор
кажется понятен, необходимо помнить, что он может быть непонятен другим
программистам, которые будут работать с кодом.
if (a == b && c == d) // Необходимо избегать!
if ((a == b) && (c == d)) // Следует использовать
2. Возвращаемые значения. Старайтесь сделать структуру программы
компактнее. Например:

Страницы