ВУЗ:
Составители:
Рубрика:
137
Правило 1. «Удобочитаемость».
Программы должны составляться таким образом, чтобы их могли
прочитать в первую очередь люди, а не машины. Людям это необходимо
для корректировки, применения и модификации программы.
Программа – это:
1) документ для последующего использования;
2) учебный материал;
3) средство для дальнейшей разработки более совершенных программ.
Правило 2. «Комментируемость».
Делайте комментариев больше, чем это кажется необходимым.
Некомментируемая программа – это, вероятно, наихудшая ошибка, ко-
торую может сделать программист, а также свидетельство дилетантского
подхода.
Программу с пояснительными комментариями значительно легче от-
лаживать, а также читать (понимать) другим программистам.
Включать комментарии следует по мере написания программы, а не
после.
Цель комментариев – облегчить понимание программы.
Типы комментариев:
вводные;
оглавления;
пояснительные.
Вводные комментарии должны начинать каждую программу, под-
программу или процедуру для пояснения того, что они делают.
Минимальная информация в вводных комментариях:
1. Назначение программы;
2. Указания по вызову программы и ее использованию;
3. Список и назначение основных переменных или массивов;
4. Указания по вводу-выводу. Список всех файлов;
5. Список используемых подпрограмм;
Страницы
- « первая
- ‹ предыдущая
- …
- 136
- 137
- 138
- 139
- 140
- …
- следующая ›
- последняя »
