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