Мастер документирования

Замечание Мастер документирования включен только в Профессиональный выпуск Visual FoxPro.

Мастер документирования составляет документацию на проекты и файлы программ. О также может провести анализ вашего кода и привести в порядок форматирование в файлах кода. Предлагая вам ответить на ряд простых вопросов, мастер помогает вам выполнить процедуру в несколько этапов. О том, как проводить дополнительную адаптацию мастера документирования, см. раздел Настройка мастера документирования.

По умолчанию мастер не модифицирует существующие файлы. Однако вы можете за ать такую модификацию на заключительном этапе.

Этап 1 - Исходный файл

Вы можете ввести имя файла проекта или имя конкретной программы.

Этап 2 - Прописные буквы

Ключевые слова это все зарезервированные слова языка программирования Visual FoxPro. Под символами понимаются переменные и имена, которые вы определяете в своем коде.

Этап 3 - Отступы

Выберите нужные опции, которые обеспечили бы единообразие в системе отступов в вашем коде.

Этап 4 - Заголовки

Заголовки это комментарии по поводу кода, предшествующие характеризуемому ими коду. Их можно помещать в начало файлов, процедур, определений классов и методов; их пре назначение облегчить процесс чтения форматированного кода.

Этап 5 - Отчеты

Отчеты, создаваемые мастером, по сути представляют собой текстовые файлы. Отчеты бывают следующих типов:

Тип отчета	Имя файла	Примечания
Action Diagram (диаграмма действий)	project.ACT	Показывает иерархические отношения внутри кода. Если вы не работаете с кодовой страницей 1250 набора ASCII и кодовой страницей 1252 набора ANSI, см. описание директивы "*# document ACTIONCHARS" в разделе Настройка мастера документирования.
Cross-Reference (перекрестные ссылки)	XREF.LST	Содержит список всех символов, определенных пользователем.
File Listing (перечень файлов)	FILES.LST	Содержит список всех файлов, входящих в проект.
Source Code Listing (исходный код)	project.LST	Помещает весь отформатированный код в один файл.
Tree Diagram (диаграмма дерева)	TREE.LST	Показывает дерево вызова процедур.

Кроме того, мастер автоматически создает следующие файлы:

Имя файла	Описание
FILES.DBF	Таблица, в которой каждая запись соответствует одному из файлов, входящих в п оект.
FDXREF.DBF	Таблица, в которой каждая запись соответствует одному экземпляру пользовате ьских символов в коде.

Таблица FDXREF.DBF содержит поле Flag, идентифицирующее ключевые слова. Испо ьзуются следующие идентификаторы:

Флаг	Описание
B	Базовый класс
C	Имя класса
D	Определенная процедура (PROC) или функция (FUNC), но не метод
F	Вызов функции: myproc( ) или DO myproc
K	Ключевое слово
M	Определение метода
N	Имя файла
O	Объект
P	Свойство объекта
R	Ссылка на пользовательский символ
V	Определение пользовательского символа (переменной): PARA, PRIV, PUBL, DIME

Этап 6 - Завершение

По умолчанию мастер не перезаписывает существующие файлы. Если вы хотите записать новые файлы кода, сохраняемые мастером, поверх старых файлов, выберите опцию Overwrite Existing Files.

Если вы выбрали опцию Place Files In A Single Directory, а затем нажали кнопку Finish, мастер предложит вам выбрать единый каталог, где он будет сохранять все создаваемые им файлы.

Если вы выбрали опцию Place Files In A New Directory Tree и затем нажали Finish, мастер попросит выбрать каталог, в котором он создаст копию исходного дерева проекта и сохранит новые, отформатированные файлы программ в соответствующих подкаталогах нового дерева.

Когда вы выбираете опцию Cross-Reference Keywords, мастер добавит в таблицу FDXREF.DBF записи для каждого экземпляра ключевых слов Visual FoxPro в вашем ко е. В зависимости от размера кода, данная опция может привести к резкому увеличе ию объема файла FDXREF.DBF. Если эта опция выбрана, мастер сравнивает ключевые слова кода с первым полем файла FDKEYWRD.DBF под именем Token. Второй столбец в файле FDKEYWRD.DBF, носящий имя Code, содержит идентификатор, по которому мастер определяет, как ему трактовать данное ключевое слово во время анализа кода. В следующей таблице приведены коды идентификаторов.

Код	Описание
I	Отступ
U	Выступ (снятие отступа)
R	Установка отступа равным 0 (или 1 для InDefineClass)
F	Процедура или функция
D	While или Case: предложение команды DO
O	Объект (Spinner, CommandButton)
P	Свойство (Scalemode, DecimalPoints)
M	Метод (Init, KeyPress)
C	Предложение, используемое именно как предложение: не может начинать оператор