Требования по оформлению исходных текстов программного обеспечения

Требования

по оформлению исходных текстов программного обеспечения.

Аннотация

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

Оглавление

1.     Введение   4

1.1.          Цель документа  4

1.2.          Сфера применения  4

1.3.          Применяемость Положения  4

1.4.          Процедура сопровождения Положения  4

1.5.          Термины, сокращения и определения  5

2.     Файлы исходного кода   5

2.1.          Именование исходных файлов  5

2.2.          Организация исходных файлов  6

2.3.          Файл проекта  7

3.     Зарезервированные слова   7

4.     Наименования   7

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

4.2.          Стандартные компоненты   7

4.3.          Пользовательские типы   8

4.4.          Классы   9

4.5.          Интерфейсы   9

4.6.          Процедуры и функции  9

4.7.          Переменные  10

4.8.          Константы   10

5.     Запись операторов и выражений   10

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

5.2.          Оператор if  11

5.3.          Оператор for  12

5.4.          Оператор while  12

5.5.          Оператор repeat until  12

5.6.          Оператор case  13

5.7.          Оператор with   13

5.8.          Оператор try  13

6.     Комментарии   14

7.     Использование пробелов и отступов   14

7.1.          Использование пустых строк  14

7.2.          Использование пробелов  15

7.3.          Использование отступов  15

8.     Borland Developer Studio   15

9.     Лист ознакомления   17

1.      Введение

1.1  Цель документа

Целью «Положения по оформлению исходных текстов на Object Pascal при выполнении проектов разработки программного обеспечения» (далее – Положения) является регламентация оформления исходных текстов на языке программирования Object Pascal при разработке ПО для обеспечения необходимого уровня разрабатываемого ПО и облегчения совместного использования исходных текстов.

1.2  Сфера применения

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

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

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

1.3  Применяемость Положения

Настоящее положения необходимо применять ко всем новым продуктам. Существующие продукты необходимо приводить в соответствии с Положением по мере необходимости.

1.4  Процедура сопровождения Положения

Настоящее Положение разрабатывается начальником отдела программного обеспечения, согласуется на Техническом совете отдела ПО  и утверждается Директором опытного (инновационного) производства.

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