В этой главе мы расскажем, как написать хорошую программу. Но прежде чем мы это сделаем, давайте посмотрим, каковы характеристики хорошей программы:
Вот несколько способов написания хороших программ.
Имя, которое идентифицирует любую переменную, объект, функцию, класс или метод, называется идентификатором. Предоставление правильных имен идентификаторов делает программу самодокументированной. Это означает, что имя объекта скажет, что оно делает или какую информацию хранит. Давайте возьмем пример этой инструкции SQL:
Посмотрите на строку 10. Она говорит всем, читающим программу, что нужно выбрать идентификатор, имя и номер ученика. Имена переменных делают это само собой разумеющимся. Вот несколько советов по созданию правильных идентификаторов имен:
На изображении выше посмотрите строку 8. Она сообщает читателю, что следующие несколько строк кода получат список учеников, чья отчетная карточка будет сгенерирована. Эта строка не является частью кода, но только для того, чтобы сделать программу более удобной для пользователя.
Такое выражение, которое не компилируется, а записывается как примечание или пояснение для программиста, называется комментарием. Посмотрите комментарии в следующем сегменте программы. Комментарии начинаются с //.
Комментарии могут быть вставлены как:
Вы должны избегать добавления лишних комментариев, поскольку это может оказаться контрпродуктивным, нарушая поток кода во время чтения. Компилятор может игнорировать комментарии и отступы, но читатель имеет тенденцию читать каждый из них.
Расстояние текста с левого или правого поля называется отступом. В программах отступы используются для разделения логически разделенных блоков кода. Вот пример отступленного сегмента программы:
Как вы можете видеть, программа с отступом более понятна. Поток управления из цикла for в if и обратно в for очень ясен. Отступы особенно полезны в случае контрольных структур.
Вставка пробелов или строк также является частью отступов. Вот некоторые ситуации, когда вы можете и должны использовать отступы: