А.3.7 Комментарии
Время, потраченное на написание комментариев, многократно окупится
при любых модификациях программы. Однако комментировать все подряд,
включая самоочевидные действия, как в следующем примере, тоже не стоит:
size = 10; //Присвоить size значение 10
for( i=0; i{
. . .
}
Такого рода комментарии только загромождают программу.
Комментировать следует:
1. Заголовок файла, описывая содержимое данного файла;
2. Заголовок функции, поясняя назначение ее аргументов и смысл самой
функции;
3. Вводимые переменные и структуры данных;
4. Основные этапы и особенности реализуемых алгоритмов;
279
5. Любые места, которые трудны для быстрого понимания, в особенности
использование различных программных "трюков" и нестандартных
приемов.
280
Достарыңызбен бөлісу: |
