12. Текст программы. Требования к содержанию

И ОФОРМЛЕНИЮ (ГОСТ 19.401-78)

Документ «Текст программы» приводится в Приложении А квалификационной работы.

Устанавливаются требования к содержанию и оформлению программного документа «Текст программы».

Структуру и оформление документа устанавливают в соответсвии с ГОСТ 19.105-78 «Общие требования к программным документам».

12.1. Общие положения

12.1.1. Программный документ может быть представлен на различных типах носителей данных.

12.1.2. Программный документ состоит из следующих частей;

– титульной;

– информационной;

– основной;

12.2. Титульная часть

Титульная часть состоит из листа, утверждения и титульного листа. Правила оформления листа утверждения и титульного листа – по ГОСТ 19.104-78.

12.3. Информационная часть

12.3.1. Информационная часть должна состоять из аннотации и содержания.

12.3.2. В аннотации приводят сведения, о назначении документа и краткое изложение его основной части.

12.3.3. Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят:

– обозначение структурного элемента (номер раздела, подраздела и т.п.);

– наименование структурного элемента;

– адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.д.).

12.4. Основная часть

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

Тексты программ должны отвечать требованиям самодокументирования.

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

Для данных необходимо описание их значение и, при необходимости, обоснование их структуры.

Для данных, используемых несколькими программными еденицами (процедурами, модулями) следует описывать их назначение, какие программные еденицы и как их изменяют и какие используют.

По тексту исполнительной части программы должны быть комментарии, описывающие и поясняющие алгоритм.

При документировании текста следует пользоваться следующими посылками:

– комментарии должны помочь разработчику в кратчайший срок восстановить знания о программе;

– комментарии должны оказать максимальную помощь другому программисту разобраться в алгоритме программы при ее сопровождении;

– необходимо следить за точностью комментариев, они должны помогать, а не приводить в заблуждение;

– плохо откомментированная программа – это реальное снижение качества ПС;

– неоправданная избыточность комментариев может также затруднить работу с программой.

13 Бібліографічний опис джерел та посилання на них

13.1 Принаписанні записки можуть бути використані такі джерела інформації: Конституція України; закони України та інших держав; інші документи законодавчого характеру (постанови, укази, рішення і т.п.); підручники; навчальні посібники; монографії; довідники; статті, виступи та інформація, опублікована в збірниках, журналах, газетах; депоновані рукописи; нормативно-технічні документи (стандарти, технічні умови, інструкції, керівництва та ін.); дисертації, звіти; каталоги; рекламні проспекти; препринти; описи до патентів і авторських свідоцтв; методичні вказівки; науково-популярні і художні твори; архівні матеріали; програми для ЕОМ; матеріали на магнітних та інших не паперових носіях й інші джерела, що допускають неодноразове використання, крім тих, що складають державну, службову чи комерційну таємницю і засекречені у встановленому порядку.

Бібліографічний опис джерела повинен відповідати вимогам ГОСТ 7.1-84 і забезпечувати можливість однозначної ідентифікації джерела. Бібліографічний опис дається мовою джерела.