Цель написания
Эта спецификация определяет программные файлы и стиль кодирования, участвующие в процессе написания программы. Данная спецификация разработана на основе языка Delphi.
Организация проектной документации
В Delphi программные файлы организованы по модулям проекта. В типовой проект входят:
Файлы проекта (файлы .DRP)
Содержит исходный код основной программы проекта на языке Pascal;
Файлы модулей (файлы .PAS)
Исходный файл Pascal для каждой формы в проекте, включая все объявления и процедуры формы (включая процедуры обработки времени);
Файлы форм (файлы .DFM)
Бинарный файл, содержащий свойства формы. Файл .DFM и файл .PAS каждой формы соответствуют друг другу.
Файл ресурсов (файл .RES)
Скомпилированные двоичные файлы ресурсов, связанные с исполняемым файлом приложения;
Файл опций проекта (файл .DOF)
Сохраняет параметры проекта, установленные командой меню PProject|Options;
Файл настроек рабочего стола (файл .DSK)
Сохраняет параметры рабочего стола, установленные командой меню «Инструменты|Параметры»;
Файл пакета (файл .DPK/.BPL)
Файлы, используемые для совместного использования компонентов, классов, данных и кода. Исходный файл — это файл .DPK, а после компиляции — файл .BPL;
постоянное определение
содержание:
Определение логических значений;
Определение постоянной стоимости;
Определение кода ошибки;
Формат: Одно определение в строке. следующее:
Const<константа>: тип = значение; //Комментарий;
проиллюстрировать:
Используйте оператор Const для объявления констант, которые используются вместо литеральных значений.
Пример: Const C_SQL:string='select CH_USERER_ID из T_CD_USER' //Запрос идентификатора пользователя;
Const C_PI:real =3,1415926 //Пи;
Определение типа структуры
Содержание: Определение типа конструкции.
Формат:
Тип
<Имя типа>//Комментарии к описанию структуры
<Имя переменной 1>: тип переменной // комментарии к описанию переменной;
<Имя переменной 2>: тип переменной // комментарии к описанию переменной;
…
Конец;
проиллюстрировать:
<Имя типа> — это строка, начинающаяся с заглавной буквы. Операторы, определяющие типы переменных в определении структуры, начинаются со второй строки и пятого столбца.
Пример:
тип
TableList=record //Определение типа единицы дерева системы
InID: Integer; //номер объекта
Имя: строка; //Имя юнита
PID: строка; //Предыдущее имя устройства
PT: PTableList; //Указатель на следующий тип объекта
конец;
Стиль программирования
Стиль программирования определяет правила расположения каждого оператора и комментариев в программе.
Стиль функции/процедуры
<функция/процедура> Имя (переменная: тип переменной [,...]);//описание функции/процедуры
вар
Переменная 1: тип переменной // описание переменной;
Переменная 2: Тип переменной //Описание переменной;
…
начинать
заявление;
заявление;
…
конец ;
Примечание. Объявления переменных и операторы записываются, начиная с третьего столбца. Если есть отступ, делайте отступ по два столбца за раз и выравнивайте по соответствующим операторам.
стиль заявления
проиллюстрировать:
Обычно на каждые десять строк в теле программы обычно приходится один абзац описания функции;
Стандартизировать использование различных утверждений;
Отступ в выписках измеряется в двух столбцах.
оператор определения переменной
вар
var_name: <тип данных>;
оператор присваивания
var_name: = <выражение>;
условное утверждение
если условие то //Комментарий
начинать
заявление;
…
конец
иначе если условие то//комментарий
начинать
заявление;
...
конец
еще//комментарий
заявление;
Примечание. Если имеется только один оператор выполнения, операторы начала и конца можно опустить.
Оператор цикла
//Аннотация функции цикла
для счетчика := от начала до конца сделать
начинать
[заявление];
…
конец;
//Аннотация функции цикла
пока [условие] делай
начинать
[заявление];
…
конец;
//Аннотация функции цикла
повторить
[заявление];
…
пока [условие]
оператор переключения
//описание функции переключения
случай <выражение> из
<значение1>:[оператор 1];
<значение2>:[оператор 2];
…
<значение>: [оператор n]
конец;
Строка комментария
Для этого файла модуля в верхней части файла модуля программного кода должны быть комментарии «Описание модуля» и «Описание модуля».
Для значимых частей кода, таких как константы, структурные типы, функции/процедуры, пользовательские переменные, функциональные блоки сегментов кода, ключевые операторы и т. д.
точки, должна быть строка комментария для подробного объяснения.
Строку комментария можно добавить с помощью «//XXXXXXXXXX» после строки, которую необходимо объяснить, или ее также можно добавить над строкой, которую необходимо объяснить.
Добавьте несколько строк, используя «{XXXXXXXX}», или добавьте одну строку, используя «//XXXXXXXX».
Именование файлов и форм
Значение формата имени класса
Файл проекта Программа(.DPR) XXXXX
ЕдиницаЕдиница(PAS) uXXXXX
ФормаФорма.Имя(.DFM) XXXXXFrm
Модуль данныхМодуль данных XXXXXDM
Определение заголовка модуля, добавленное перед каждым модулем.
{************************************************ * ***
Название подразделения:
Описание функции:
автор:
Название программного обеспечения:
Версия:
Название компании: Sword as Dream Software Creation Studio
************************************************* * *** }
Определение формата номера версии программного обеспечения:
Программное обеспечение использует следующий формат номера версии: XXXX.
Например: после завершения выпуска программы номер версии отмечается как «1.0.0.0».
Первая цифра: номер версии. Примечание. Это значительно улучшенная версия программного обеспечения.
Вторая цифра: номер технического обслуживания. Примечание. Некоторые ошибки были изменены на основе существующей версии.
Третья цифра: номер патча. Примечание. Когда программа исправляет некоторые ошибки и новый номер обслуживания не формируется, используется номер исправления.
Четвертая цифра: номер исправления. Примечание. При возникновении аварийной программной ошибки измененная программа используется в качестве идентификатора, а не номера версии выпущенной программы. ууууу