Как известно, людям свойственно ошибаться. Особенно это верно в отношении программистов. По некоторым оценкам ядро системы Linux содержит порядка 15000 пока еще не исправленных ошибок (источник). Практически любой написанный вами текст программы будет содержать ошибки и значительная часть времени будет уходить на их поиск и исправление.
Отсюда вытекает преставление о стиле программирования. Существуют определенные правила написания программ, соблюдение которых позволяет уменьшить вероятность появления ошибок. Программы (особенно такие простые, как вам придется писать на начальном этапе) могут правильно работать и при нарушении этих правил, однако все же следует их соблюдать. Дополнительное время и усилия, которые будут на это потрачены, многократно окупятся впоследствии.
Простейшее, но при этом очень важное стилистическое правило описывает то, как надо располагать текст программы. Существует несколько вариантов соглашений о правильном расположении текста. В данном пособии мы будем следовать Object Pascal Style Guide — стандарту, выработанному разработчиками языка Delphi. Итак, следует действовать следующим образом:
Как оформить реферат по ГОСТУ 2020 года за 5 минут (Пример правильного оформления)
1) Слово var пишется на отдельной строчке. Следующие за ним описания переменных начинаются с новой строки. При этом у всех описаний делается отступ слева в два пробела. Переменные разных типов описываются на разных строках.
var x, y: real; i: integer;
2) В полиграфии существует такое понятие как типографика. Это набор правил, описывающий как должен располагаться на страницах книги текст, чтобы быть удобочитаемым. Одно из простых правил говорит, что после знаков препинания всегда ставится пробел. Не следует пренебрегать этим правилом и при написании программ. Пробел всегда следует ставить после запятых и двоеточий (как в вышеприведенном примере).
3) Слова begin и end, ограничивающие раздел операторов пишутся без отступа. Весь же текст программы между ними снова пишется с отступом в два пробела.
4) На одной строке должен располагаться только один оператор. Так, хотя допустимо писать, например:
begin x:=1; y:=2; z:=3; writeln(x, y, z); end.
следует все же писать:
begin x:=1; y:=2; z:=3; writeln(x, y, z); end.
5) Условный оператор записывается следующим образом:
begin . if then begin end else begin end;
Пример правильного оформления:
var x, y: real; begin readln(x, y); if x > y then begin writeln(‘Max(x, y) = ‘, x); end else begin writeln(‘Max(x, y) = ‘, y); end; readln; end.
Пример НЕправильного оформления:
var x, y: real; begin readln(x, y); if x > y then writeln(‘Max(x, y) = ‘, x) else begin writeln(‘Max(x, y) = ‘, y); end; readln; end.
Данная «неправильная» программа будет работать совершенно также, как и приведенная выше «правильная», однако использовать надо именно правильный вариант.
6) Внутри условного оператора могут располагаться любы другие операторы, в том числе и другие условные операторы. То, что находится внутри них, пишется с еще большим отступом.
7 психологических трюков, которые усилят ваш текст | GeniusMarketing
begin readln(x, y, z); if x > y then begin if x > z then begin writeln(x); end; end; end.
Общая идея такова: отступы показывают подчиненность (вложенность) структур в вашей программе. Текст внутри раздела операторов — делаем отступ, внутри условного оператора — еще больший отступ, внутри еще одного условного оператора — еще больший отступ и т. д.
Соблюдение данных правил делает визуально очевидной логическую структуру вашей программы. Создание сколько-нибудь сложной программы без этого оказывается невозможным.
Источник: www.tvd-home.ru
3. Оформление текстов программ
Тексты программ должны оформляться в соответствии с «хорошим стилем» программирования, т. е. должны быть легко читаемы и хорошо документированы. В текстах должны быть комментарии:
- после заголовка программы или подпрограммы приводится общая информация: назначение, входные данные, результаты, метод решения; данные о программисте, дата написания, версия;
- при объявлении данных – назначение переменных;
- в начале и в конце определенной функционально законченной части программы;
- для пояснения логических частей программы (ветвлений, циклов).
- пустых строк между текстами подпрограмм и отдельных ее функционально законченных частей;
- сдвигами текста в строке при написании:
- заголовков вложенных циклов;
- тела цикла после его заголовка;
- альтернатив разветвлений процесса обработки данных.
4. Оформление приложений
Каждое приложение должно начинаться с новой страницы с указанием наверху посередине страницы слова «ПРИЛОЖЕНИЕ» прописными буквами и иметь тематический заголовок, который записывается симметрично относительно текста с прописной буквы отдельной строкой. Приложения обозначаются заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, Щ, Ч, Ь, Ъ, Ы. Допускается обозначение приложений буквами латинского алфавита, за исключением букв IиO.
Если в документе одно приложение, оно обозначается «ПРИЛОЖЕНИЕ А». Например: ПРИЛОЖЕНИЕ В Титульный лист расчетно-пояснительной записки Рисунки и таблицы, помещаемые в приложении, нумеруются арабскими цифрами в пределах каждого приложения с добавлением буквы приложения.
Например: рисунок А.12 — 12-й рисунок приложения А; рисунок В.2 — 2-й рисунок приложения В; таблица Г.3 — 3-я таблица приложения Г. Каждый файл в приложении оформляется как рисунок с наименованием файла и его назначением. Например: Рисунок А.3 — Файл mod1.pas– исходные тексты библиотеки процедур обработки. Рисунок В.4 — Файл menuran.pas– программа движения курсора основного меню.
5. Оформление списка используемых источников
Список литературы должен включать все использованные источники. Сведения о книгах (монографиях, учебниках, пособиях, справочниках и т.д.) должны содержать: фамилию и инициалы автора, заглавие книги, место издания, издательство, год издания. При наличии трех и более авторов допускается указывать фамилию и инициалы только первого из них со словами «и др.».
Наименование места издания надо приводить полностью в именительном падеже: допускается сокращение названия только двух городов: Москва (М.) и Санкт-Петербург (СПб.). Сведения о статье из периодического издания должны включать: фамилию и инициалы автора, наименование статьи, наименование издания (журнала), наименование серии (если она есть), год выпуска, том (если есть), номер издания (журнала) и номера страниц, на которых помещена статья. При ссылке на источник из списка литературы (особенно при обзоре аналогов) надо указывать порядковый номер по списку литературы, заключенный в квадратные скобки; например: [5]. ПРИЛОЖЕНИЕ А Титульный лист расчетно-пояснительной записки Министерство образования И НАУКИ Российской Федерации ВОРОНЕЖСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ ФАКУЛЬТЕТ Автоматизации и роботизации машиностроения КАФЕДРА Графики, конструирования и информационных технологий в промышленном дизайне
Источник: studfile.net
Правила оформления текстов программ
Комментарии
Популярные По порядку
Не удалось загрузить комментарии.
ЛУЧШИЕ СТАТЬИ ПО ТЕМЕ
Шаблоны проектирования в Python: для стильного кода
Многие шаблоны проектирования встроены в Python из коробки, а другие очень просто реализовать, используя базовые возможности языка.
Учитесь писать код без If
Зачем писать код с if, если можно этого не делать? Вот почему.
4 лучших книг о шаблонах проектирования
Лучшие книги о шаблонах проектирования, рассчитанные как для новичков, так и для уже более опытных программистов.
Источник: proglib.io