Оформление текста программы

С точки зрения технологичности хорошим считают стиль оформления программы, облегчающий ее восприятие, как самим автором, так и другими программистами.

Исходя из того, что любую программу неоднократно придется просматривать, следует придерживаться следующего стиля написания программ:

а) Правила именования объектов программы (переменных, функций, типов данных и т.п.). Имена программных объектов должны соответствовать его содержанию. Использовать символ «_» для визуального разделения имен, состоящих из нескольких слов (например, Max_Item – максимальный элемент). Избегать близких по написанию имен.

б) Правила оформления модулей и подпрограмм. Каждый модуль и подпрограмма должны предваряться заголовком, который содержит:

- название модуля или подпрограммы;

- краткое описание его назначения;

- краткое описание входных и выходных параметров с указанием единиц измерения;

- список используемых модулей и вызываемых подпрограмм;

- краткое описание алгоритма (метода) и ограничений;

- ФИО автора программы;

- идентифицирующую информацию (номер версии и/или дату последней корректировки).

в) Стиль оформления текста программы. Стиль определяет использование отступов, пропусков строки и комментариев, облегчающих понимание программы. Использование отступов позволяет прояснить структуру программы, обычно дополнительный отступ обозначает вложение операторов языка. Комментировать следует цели выполнения тех или иных действий, а также группы операторов, связанных общим действием, т.е. комментарии должны содержать некоторую дополнительную (неочевидную) информацию.

Требования к тексту работы

Работа должна быть написана научным языком с соблюдением следующих требований:

1. Мысли должны быть изложены четко, последовательно и конкретно.

2. Каждая новая мысль должна начинаться с абзаца (красной строки).

3. В работе не рекомендуется применять местоимение «я» и глаголы в первом лице, мысли необходимо излагать так, чтобы было видно, где излагаются мысли автора работы, а где других авторов. Например, «автор считает», «по мнению автора» и т.д.

4. При использовании в работе цитат необходимо точно воспроизводить цитируемый текст и обязательно оформлять ссылку на источники в соответствии с установленными правилами.

5. Сокращение слов в тексте не допускается. Исключение составляют сокращение слов в библиографическом описании по ГОСТу 7.12 - 93 «Библиографическая запись. Сокращение слов на русском языке. Общие требования и правила составления», а также сокращение слов на иностранных языках по ГОСТу 7.11.-78 «Сокращение слов и словосочетаний на иностранных языках в библиографическом описании» [2,3].

6. В тексте работы разрешается употреблять аббревиатуры. Применять аббревиатуры можно только после разъяснения их значений. Разъяснение достаточно дать один раз, при первом употреблении. Сначала записывается полная расшифровка аббревиатуры, а затем в круглых скобках записывается аббревиатура. Кроме того, после содержания в работе помещается список сокращений, использованных в тексте.

7. В курсовых работах по информационным технологиям студентам разрешается разместить в верхних колонтитулах страниц ФИО студента и название текущего раздела.

Библиографический список

Библиографическое описание документа осуществляется в соответствии с ГОСТом 7.1.-84 «Библиографическое описание документа. Общие требования и правила составления».

Каждый используемый в работе источник и книга должна быть соответствующим образом описаны. В это описание входит:

- фамилия и инициалы автора (или авторов, если их не более трех);

- заглавие;

- данные, уточняющие читательское назначение книги;

- сведения о лицах, принимавших участие в создании книги;

- указание на повторность издания;

- место издания;

- издательство;

- год издания;

- количество страниц.

Библиографическое описание книг составляется на основании всех данных, вынесенных на титульный лист используемого источника. Отдельные элементы описания располагаются в строго определенном порядке и отделяются друг от друга установленными условными разделительными знаками: фамилия и инициалы автора (авторов), заглавие (без сокращений); после косой черты – сведения об авторах (если их более двух), составителях, редакторах и других лиц, участвовавших в создании книги, а также о переводчике, если это перевод; указание на повторность издания; место издания, издательство, год издания, количество страниц.

Библиографическое описание статьи (или другой составной части документа) из сборника, книги или журнала включает: фамилию и инициалы автора (авторов), заглавие статьи и за двумя косыми чертами – описание самого сборника, книги или журнала, где опубликована статья. В конце указываются страницы, на которых помещена статья.

При использовании материала из литературных источников в квадратных скобках необходимо указать порядковый номер источника, соответствующий списку использованной литературы (используйте средства текстового процессора – перекрестную ссылку на абзац). Например: [2, 5, 7]. При цитировании следует упомянуть фамилию и инициалы автора, вместе с номером источника указать номер страницы, с которой взята цитата.

Библиографический список должен быть оформлен с применением формата нумерованного списка. В процессе работы источники можно располагать в порядке использования, но после завершения их необходимо упорядочить в алфавитном порядке (отсортировать средствами текстового процессора и обновить поля с перекрестными ссылками).

Примеры оформления библиографического списка приведёны в Приложении Б.