Программу гораздо легче читать, и она становится намного понятнее, если
разумно использовать комментарии и систематически выделять текст
программы пробелами. Есть несколько способов расположения текста
программы, но нет причин считать, что один из них - наилучший. Хотя
у каждого свой вкус. То же можно сказать и о комментариях.
Однако можно заполнить программу такими комментариями, что читать
и понимать ее будет только труднее. Транслятор не в силах понять
комментарий, поэтому он не может убедиться в том, что комментарий:
[1] осмысленный,
[2] действительно описывает программу,
[3] не устарел.
Во многих программах попадаются непостижимые, двусмысленные и просто
неверные комментарии. Лучше вообще обходиться без них, чем давать
такие комментарии.
Если некий факт можно прямо выразить в языке, то так и следует
делать, и не надо считать, что достаточно упомянуть его в комментарии.
Последнее замечание относится к комментариям, подобным приведенным
ниже:
// переменную "v" необходимо инициализировать.
// переменная "v" может использоваться только в функции "f()".
// до вызова любой функции из этого файла
// необходимо вызвать функцию "init()".
// в конце своей программы вызовите функцию "cleanup()".
// не используйте функцию "weird()".
// функция "f()" имеет два параметра.
При правильном программировании на С++ такие комментарии обычно
оказываются излишними. Чтобы именно эти комментарии стали ненужными,
можно воспользоваться правилами связывания ($$4.2) и областей
видимости, а также правилами инициализации и уничтожения объектов
класса ($$5.5).
Если некоторое утверждение выражается самой программой, не нужно
повторять его в комментарии. Например:
a = b + c; // a принимает значение b+c
count++; // увеличим счетчик count
Такие комментарии хуже, чем избыточные. Они раздувают объем текста,
затуманивают программу и могут быть даже ложными. В то же время
комментарии именно такого рода используют для примеров в учебниках
по языкам программирования, подобных этой книге. Это одна из
многих причин, по которой учебная программа отличается от настоящей.
Можно рекомендовать такой стиль введения комментариев в
программу:
[1] начинать с комментария каждый файл программы: указать в
общих чертах, что в ней определяется, дать ссылки на
справочные руководства, общие идеи по сопровождению
программы и т.д.;
[2] снабжать комментарием каждое определение класса или шаблона
типа;
[3] комментировать каждую нетривиальную функцию, указав: ее
назначение, используемый алгоритм (если только он неочевиден)
и, возможно, предположения об окружении, в котором работает
функция;
[4] комментировать определение каждой глобальной переменной;
[5] давать некоторое число комментариев в тех местах, где
алгоритм неочевиден или непереносим;
[6] больше практически ничего.
Приведем пример:
// tbl.c: Реализация таблицы имен.
/*
Использован метод Гаусса
см. Ральстон "Начальный курс по ..." стр. 411.
*/
// в swap() предполагается, что стек AT&T начинается с 3B20.
/************************************
Авторские права (c) 1991 AT&T, Inc
Все права сохранены
**************************************/
Правильно подобранные и хорошо составленные комментарии играют в
программе важную роль. Написать хорошие комментарии не менее
трудно, чем саму программу, и это - искусство, в котором стоит
совершенствоваться.
Заметим, что если в функции используются только комментарии
вида //, то любую ее часть можно сделать комментарием с помощью
/* */, и наоборот.
Программирование, блок
схема, программа, информатика, алгоритм, управление, система управления, разделяй
властвуй, языки программирования, линейное программирование, сложность, книги
программирование, организация, развитие, проектирование, самосовершенствование,
развитие систем, программирование скачать, программирование c, задачи программирование,
динамическое программирование, ориентированное программирование, методы программирования,
объектно программирование, примеры программирования, задача линейного программирования,
основы программирования, объектно ориентированное программирование, программирование
учебник, технология программирования, программирование си, программирование
скачать книги, исходники, исходники на c, c, с, програмирование, книги по с,
разработка программ, государственное управление, методы управления, управление
организацией, структуры управления, управление проектами, управление рисками,
теории управления, скачать управление, процесс управления, исследование управления,
программа управления, схемы управления, информационное управление, управление
образования, стратегическое управление, исследование систем управления, социальное
управление, функции управления, технология управления, модели управления, блок
управления, организационное управление, менеджмент управления, психология управления,
управление ресурсами, управление производством, принципы управления, корпоративное
управление, управление работами, дистанционное управление, эффективность управления,
управление компьютером, пульты управления, проблемы управления, области управления,
основы управления, управление конфликтами, обеспечение управления, управление
деятельностью, анализ управления, автоматизированное управление, стили управления,
организационные структуры управления, автоматическое управление, современное
управление, подходы управления, управление службами, стратегии управления, социология
управления, управление развитием, объект управления, информационные технологии
управления, автоматизированные системы управления, совершенствование управления,
управление средствами, управление потоками, оперативное управление, механизм
управления, управление удаленным, примеры управления, управление через, понятие
управление, особенности управления, задачи управления, сфера управления, управление
культуры, право управления, управление собственностью, управление книги, концепция
управления, управление трудом, панель управления, опыт управления, информационные
системы управления, формы управления, роль управления, политика управления,
контроль управления, организация, управление организацией, организация труда,
организация производства, теория организации, организация система, организация
учета, структура организации, формы организации, анализ организации, принципы
организации, организация процессов, развитие организации, пример организации
, среда организации, организация контроля, метод организации, внутренняя организация,
стратегии организации, понятие организация, уровни организации, основы организации,
функции организации, современная организация, организация проекта, развитие,
перспективы развития, этапы развития, программа развития, тенденции развития,
развитие систем, стратегия развития, проблемы развития, концепция развития,
развитие личности, дети развитие, современное развитие, развитие ребенка, план
развития, теория развития, психология развития, особенности развития, развитие
техники, развитие человека, развитие образования, устойчивое развитие, развитие
памяти, фактор развития, развитие способностей, управление развитием, развитие
связи, развитие технологии, развитие мышления, направления развития, пути развития,
модели развития, русское развитие, развитие жизни, основные этапы развития,
развитие страны, возникновение развитие, стратегическое развитие, развитие информационного
развития, скачать развитие, развитие персонала, методы развития, творческое
развитие, развитие языка, развитие школьника, проектирование, проектирование
систем, проектирование программа, нормы проектирования, проектирование информационных,
проектирование данных, проектирование информационной системы, проектирование
базы, организационное проектирование, основы проектирования, автоматизированное
проектирование, проектирование скачать, организация проектирования, методы проектирования,
управление проектирование, технологическое проектирование, проектирование процессов,
этапы проектирования, системы автоматизированного проектирования
