Стиль программирования. Основной принцип хорошего стиля программирования - писать так, что бы программу могли прочесть не только машины, но и люди. Стиль - набор приемов или методов программирования, используемых получения правильных, удобных для применения, легко читаемых и, желательно эффективных программ. Особый стиль - это программы, понятные лишь вам.
Приемы формирования листинга просты. Исторически листингом называли распечатку текста программы. Сейчас под этим можно понимать размещение текста программы на любом носителе: бумаге, экране и т.п. Следует записывать 1 инструкцию (кроме сложных) в строку. Отступ - это абзац, выявление структуры программы. Используется, как правило, при записи сложных инструкций, имеющих в своем составе другие инструкции. Рекомендуемый размер отступа для вложенных инструкций 4-5 позиций. Размер отступа должен быть одинаков по всей программе.
Комментарии. Цель - пояснить логику, облегчить отладку, тестирование и сопровождение программ. При написании комментариев следует учитывать уровень возможных читателей текста программы. Второй момент: когда писать? Рекомендуется записывать комментарии одновременно с текстом программы. После написания текста процедуры необходимо прочесть его и во всех местах, где возможен вопрос, прокомментировать.
Вопрос о количестве (объеме) комментариев является дискуссионным. Их количество зависит от сложности логики программы, числа процедур и используемых библиотечных функций, а также от того, является ли программа коллективной разработкой или нет. Можно указать такой косвенный критерий достаточности объема комментирования: объем комментариев должен быть таков, чтобы при чтении ее текста, скажем через 1 год, можно было достаточно легко разобраться в логике и структуре программы. Можно также привести грубый количественный критерий: ориентировочный объем комментариев - 50-70% от объема кода программы.
Различают следующие типы комментариев: оглавления, вводные, пояснительные. Оглавления - Разумно составлять для программ, объем кода которых превышает 300 - 500 КБ. Вводные - записываются перед началом текста процедуры. Пояснительные - служат для пояснения. Принцип комментирования: программа должна быть понятна без привлечения дополнительной документации.
Имена. Имена объектов программы должны быть осмысленными. Пример. tip razmer adress. В настоящее время во всем мире приняты 2 системы записи (нотации) "паскалевская" и "венгерская". Обе рекомендуют использовать имена, состоящие в общем случае, из нескольких слов. В "паскалевской" нотации каждое слово начинают с прописной буквы.
Пример. ВедКт EndKm FieidName
В "венгерской" нотации перед именем записывается тип объекта программы
Пример. intBegKm intEndKm charFieldName
Не используйте в программе сходные имена!
Пример. value values ах1 axi к К
Если имя содержит цифры, записывайте их в конце.
Пример. fundi ТаЫ5
Имя не должно совпадать с ключевым словом (для языков, где ключевые слова не резервируются) или с именем библиотечной или встроенной функции.
Общие приемы программирования.
1) Изучайте и используйте библиотечные функции.
2) Не злоупотребляйте трюками. (Например, такими как из раздела «Трюки»).
3) Не игнорируйте предупреждения и старайтесь их ликвидировать.
4) Старайтесь избегать промежуточных переменных. Формулы следует записывать в том же виде как это принято в математике.
5) Не изменяйте значение параметра цикла внутри тела цикла. Это затрудняет понимание логики программы. Кроме того, некоторые языки программирования (Fortran) в целях оптимизации по времени работы помещают копию параметра цикла в регистр процессора. В этом случае изменение параметра цикла в теле цикла не повлияет на условие его выполнения, что почти наверняка приведет к ошибке.
6) Не используйте инструкции переход типа goto. Эти инструкции нарушают естественный порядок выполнения программы. Придерживайтесь принципа: текст программы надо читать как книгу слева направо и сверху вниз.
7) Объявляйте все переменные явно.
8) Не используйте одни и те же переменные для различных целей. Т.к. при последующей модификации одного фрагмента кода ошибки могут возникнуть в другом фрагменте.
9) Активно используйте удобные и понятные особенности языка.
10) Используйте исчерпывающие проверки.