ВУЗ:
Составители:
Рубрика:
100
Вводные комментарии должны начинать каждую программу, подпро-
грамму или процедуру для пояснения того, что они делают.
Минимальная информация в вводных комментариях:
1. Назначение программы;
2. Указания по вызову программы и ее использованию;
3. Список и назначение основных переменных или массивов;
4. Указания по вводу-выводу. Список всех файлов;
5. Список
используемых подпрограмм;
6. Название примененных математических методов, а также ссылки на ма-
териалы-источники, где содержится их описание;
7. Сведения о времени выполнения программы;
8. Требуемый объем памяти;
9. Специальные указания оператору;
10.Сведения об авторе;
11.Дата написания программы.
Оглавление – это комментарий, который используют в больших программах
и содержит название, размещение и функцию каждого программного модуля.
Пояснительные комментарии необходимы в тех частях программы, ко-
торые трудно понять без комментариев.
Пояснительные комментарии обеспечивают словесное описание логики
программы и изменения данных.
Комментировать следует каждый логически выделенный блок программы.
Комментарии должны содержать некоторую дополнительную информа-
цию, а не перефразировать программу.
Комментарии должны указывать цель действия или объяснять логику про-
граммы
, а не пояснять синтаксис языка программирования.
Правило 3 «Корректность комментариев».
Неправильные комментарии хуже, чем их отсутствие.
Правило 4 «Наглядность комментариев».
Располагать комментарии следует таким образом, чтобы это не делало про-
грамму менее наглядной.
Правило 5 «Пропуск строк» – метод улучшения наглядности программ.
В программе должны быть выделены фрагменты, логически самостоятель-
ные блоки.
Правило 6 «Пробелы» следует ставить везде, где это приводит к улучше-
нию читаемости программы.
Страницы
- « первая
- ‹ предыдущая
- …
- 99
- 100
- 101
- 102
- 103
- …
- следующая ›
- последняя »
