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

Примечание:
По умолчанию мастер не модифицирует существующие файлы.

Вы можете настроить работу мастера Документирования, добавляя некоторые директивы к вашему коду. О том, как проводить дополнительную адаптацию мастера документирования, см. раздел Настройка мастера документирования..

Получить доступ к Мастеру Документирования можно через меню Tools, выберите Wizards, и нажмите Documenting.

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

Вы можете ввести имя файла проекта или имя конкретной программы. Если Вы выбрали файл проекта, мастера Документирования обработает все программные файлы в вашем проекте, включая код событий форм, код библиотек классов, и так далее.

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

На этом этапе, Вы выбираете должен ли Мастер Документирования преобразовать написание ключевых слов и символов прописными буквами в текстовх файлах вашего кода. Ключевые слова это все зарезервированные слова языка программирования Visual FoxPro. Под символами понимаются переменные и имена, которые вы определяете в своем коде. Преобразование букв в прописные облегчает возможность читать и идентифицировать элементы в вашем коде. Варианты преобразования букв в прописные:

UPPERCASE

Все буквы в ключевых словах и символах отображаются прописными.
lowercase

Все буквы в ключевые слова и символы отображаются в нижнем регистре.
MixedCase

Первая буква каждого слова ключевого слова отображается прописными буквами, например, AddObject.
Match first occurrence

Отображает символы согласно преобразованию букв в прописные первого использования в файле. Например, если Вы применяете начальную заглавную букву при первом использовании в файле, все следующие возникновения этих ключевых слов будут отображены также, независимо от того как они могли бы быть напечатаны в последующем.
No change

Ключевые слова и символы не изменяются.

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

На этом этапе, Вы определяете, как Мастер Документирования выровняет строки в текстовом файле вашего кода. Мастер может выровнять определенные типы строк, и Вы можете корректировать сколько пробелов, использовать при выравнивании. Функционально, в коде, нет никакого различия между пробелами или позициями табуляции. Выравнивание облегчает возможность читабельность и понимание вашего кода.

Type of Indent

Выберите, должен ли мастер для форматирования использовать символы табуляции или пробелы. Для отключения выравнивания, выберите No Change. Если Вы выбираете Spaces, то Вы должны задать количество пробелов, которые будут использыватся. Если Вы выбираете Tabs, то Мастер Документирования использует текущую установку позиции табуляции Visual FoxPro.
Text to indent

Определите тип строки, которую мастер должен выровнять. Ваши выбор - Комментарии, Условные переходы ( циклs, блоки IF, и DO CASE СТРУКТУРЫ), и Строки продолженные точкой с запятой (инструкции, которые разбиты поперек множественных строк).

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

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

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

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

Тип отчета Имя файла Примечания

Action Diagram (диаграмма действий)

project.act

Показывает иерархические отношения внутри кода. Если вы не работаете с кодовой страницей 1250 набора ASCII и кодовой страницей 1252 набора ANSI, см. описание директивы "*# document ACTIONCHARS" in в разделе Настройка мастера документирования.

Cross-Reference (перекрестные ссылки)

Xref.lst

Содержит список всех символов, определенных пользователем.

File Listing (перечень файлов)

Files.lst

Содержит список всех файлов, входящих в проект.

Source Code Listing (исходный код)

project.lst

Помещает весь отформатированный код в один файл.

Tree Diagram (диаграмма дерева)

Tree.lst

Показывает дерево вызова процедур.

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

  • Files.dbf   Таблица, в которой каждая запись соответствует одному из файлов, входящих в проект.

  • Fdxref.dbf   Таблица, в которой каждая запись соответствует одному экземпляру пользовательских символов (как перечислено в следующей таблице) в коде. Эта таблица позволяет Вам видеть, каким элементом Visual FoxPro представлен каждым символом.

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

Flag Описание

B

базовый класс

C

Имя класса

D

Определенная ПРОЦЕДУРА или ФУНКЦИЯ (не метод)

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, содержит идентификатор, по которому мастер определяет, как ему трактовать данное ключевое слово во время анализа кода. В следующей таблице приведены коды идентификаторов.

Кроме того, когда эта опция выбрана, мастер сопоставит ключевое слово в вашем коде с первым полем, именем Token, в файле Fdkeywrd.dbf. Этот файл можно найти в ..\Wizards папке корневого каталога Visual FoxPro и он все зарезервированные слова Visual FoxPro. Второй столбец в файле FDKEYWRD.DBF, носящий имя Code, содержит идентификатор, по которому мастер определяет, как ему трактовать данное ключевое слово во время анализа кода. В следующей таблице приведены коды идентификаторов.

Код Описание

I

Отступ

U

Выступ (снятие отступа)

R

Установка отступа равным 0 (или 1 если в DefineClass)

F

Процедура или функция

D

While или Case: предложение команды DO

O

Объект (Spinner, CommandButton)

P

Свойство (Scalemode, DecimalPoints)

M

Метод (Init, KeyPress)

C

Предложение, используемое именно как предложение: не может начинать оператор

Примечание:
В зависимости от размера вашего кода, эта опция может увеличить количество записей в Fdxref.dbf . Перед выполнением мастера и выбора опции, для создания перекрестных ссылок ключевых слов, убедитесь, что Вы имеете достаточное дисковое пространство.

Когда Вы выбираете Run analyzer, мастер вызывает старт Анализатора кода Visual FoxPro, который динамически прослеживает структуру и символы в файлах приложения Visual FoxPro. Анализатор кода обеспечивает визуальный контроль, меню, и клавиатурные опции, для перемещения по текстовым файлам вашего приложения кода файла, используя вывод от мастера Документирования.

Смотреть также