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

Замечание Мастер документирования включен только в редакцию Professional Edition of Visual FoxPro.

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

Отступы в структурах CASE

По умолчанию мастер ожидает найти в структурах CASE отступы следующего вида:

DO CASE

CASE case1=1

case2=2

CASE case3=3

case4=4

ENDCASE

Некоторые разработчики предпочитают отступать еще на один уровень в строках между операторами DO CASE и ENDCASE, например:

DO CASE

CASE case1=1

case2=2

CASE case3=3

case4=4

ENDCASE

Если вы в структурах CASE делаете отступы по второму образцу, укажите это в файле FDKEYWRD.DBF. Для этого замените значение в поле Code на "UU" для записи ENDCASE.

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

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

Директивы можно вставлять в следующие файлы:

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

В отдельные файлы кода, чтобы мастер знал, как анализировать конкретные файлы.

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

*# document directive

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

Далее описываются директивы мастера документирования.

*# document ACTIONCHARS "abcdef"

По умолчанию, когда мастер документирования создает диаграмму действий или иаграмму дерева, он использует шесть символов, которые имеют вид линий и квадратн х углов при просмотре в FoxFont в кодовой странице ASCII с номером 1250 или в кодовой странице ANSI с номером 1252. Не всем этим символам соответствуют симво ы линий при просмотре в других кодовых страницах. Используемые по умолчанию шесть символов и соответствующие им символы FoxFont обозначаются в нижеприведен ой таблице как a, b, c, d, e и f.

abcdef	Значение по умолчанию для Chr( )	Вид в FoxFont
a	32	(пробел)
b	196
c	179
d	218
e	192
f	195

Совет Если вы используете другие кодовые страницы, вставьте в файл основной прог аммы приведенный ниже код; он обеспечит изображение линий на ваших диаграммах п иемлемыми символами (первый символ в строке, заключенной в кавычки, пробел):

Список поддерживаемых кодовых страниц см. в Кодовые страницы, поддерживаемые в Visual FoxPro.

*# document XREF cMode

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

cMode
ON	Включает формирование перекрестных ссылок для переменных
OFF	Отключает формирование перекрестных ссылок для переменных
SUSPEND	Отключает формирование перекрестных ссылок для переменных в текущем файле до тех пор, пока мастер документирования не обнаружит следующую директиву *# document XREF ON

*# document EXPANDKEYWORDS cMode

Обеспечивает развертывание ключевых слов. Например, "DEFI WIND" разво ачивается в "DEFINE WINDOW." Значение по умолчанию OFF.

Предупреждение Не все ключевые слова Visual FoxPro начинаются с уникальной последователь ости из четырех символов. Например, "REPL" может служить сокращением и от "REPLACE", и от "REPLICATE". Будьте осторожны при использовании этой директивы, если в собираетесь перезаписывать существующие файлы.

cMode	Описание
ON	Включает развертывание ключевых слов
OFF	Отключает развертывание ключевых слов
SUSPEND	Отключает развертывание ключевых слов в текущем файле до следующей директивы *# document EXPANDKEYWORDS ON

*# document XREFKEYWORDS cMode

Данная директива соответствует опции Cross Reference Keywords, используемой на "Этапе 6 - Завершение" работы мастера документирования. Значение по умолчанию OFF.

cMode	Описание
ON	Включает формирование перекрестных ссылок для ключевых слов
OFF	Отключает формирование перекрестных ссылок для ключевых слов
SUSPEND	Отключает формирование перекрестных ссылок для ключевых слов в текущем файле о следующей директивы *# document XREFKEYWORDS ON

*# document ARRAYBRACKETS cMode

Значение по умолчанию OFF.

cMode	Описание
ON	Мастер документирования исходит из того, что квадратные скобки используются д я массивов, а круглые скобки для функций и методов.
OFF	Мастер документирования рассматривает и квадратные, и круглые скобки как атри уты массива.

*# document ACTIONINDENTLENGTH nSpace

nSpace задает число пробелов величиной с символ, которые мастер документирования до жен использовать при формировании осттупов. Минимальное допустимое значение рав о 2.