По правилам и для удобства работы комментарии должны создаваться еще до написания программы. Обычно в их роли выступает подробный алгоритм, изложенный на обычном языке. До написания кода полезно подробно указать последовательность и содержание действий, которые должна выполнять программа, с помощью алгоритмического языка. Это дает возможность в деталях продумать интерфейсы и алгоритмы работы модулей, избежать серьезных ошибок на самой ранней стадии разработки. Благодаря такой работе значительно упрощается написание текста программы, оно заключается в вставке фрагментов кода между уже готовыми комментариями. В этом заключается суть универсальности метода – программу, оформленную таким образом можно в любой момент передать другому программисту.
Комментарии должны быть написаны простым языком и не подтверждать очевидное. Например, «объявление массива» или «вызов функции » и т.д.
Если комментарий занимает несколько строк, то его следует выровнять по вертикали и разместить до фрагмента соответствующего кода, а не справа от него. Отступ комментария должен совпадать по размеру отступу комментируемого участка кода.
После написания программы код необходимо тщательно отредактировать: отформатировать текст, убрать ненужные участки кода, оптимизировать проверки условий и циклы, сгруппировать описания и т.д. Безусловно, текст программы должен быть написан с соблюдением правил структурного программирования.
Получайте новые статьи блога прямо себе на почту