Przy tworzeniu dokumentacji np. do funkcji
bibliotecznych, kt�re s� u�ywane w wielu systemach,
przydatna jest mo�liwo�� sparametryzowania sekcji
og�lnej komentarza (opis: Sekcja 13.2.10) oraz sekcji komentarzy
do��czalnych (opis: Sekcja 13.2.11)
zmiennymi, kt�re s� nast�pnie rozwijane do r�nych
ci�g�w tekstu w zale�no�ci od dyrektyw podanych w
komentarzu w programie, dla kt�rego generowana jest
dokumentacja. U�ycie zmiennej ma posta�:
%nazwa zmiennej%
Nazwa zmiennej mo�e sk�ada� si� z dowolnych znak�w poza
znakiem nowej linii, znakiem procenta
(
%), znakiem r�wno�ci
(
=) oraz przecinkiem
(
,). Aby w komentarzu w programie,
dla kt�rego generowana jest dokumentacja, przypisa�
danej zmiennej okre�lony tekst, nale�y u�y� dyrektywy
(zapisanej w ca�o�ci w jednej linii):
<!-- subst (nazwa zmiennej 1 = warto�� zmiennej 1, nazwa zmiennej 2 = warto�� zmiennej 2) -->
Warto�� zmiennej mo�e sk�ada� si� z dowolnych znak�w
poza znakiem nowej linii, znakiem r�wno�ci
(
=) oraz przecinkiem
(
,). Do dyrektywy
subst mo�na poda� dowoln� liczb�
par zmienna-warto��. Je�li w komentarzu zostanie
napotkana zmienna, dla kt�rej wcze�niej nie zdefiniowano
warto�ci do podstawienia, w komentarzu wynikowym
zostanie umieszczona nazwa tej zmiennej. Aby ca�kowicie
unikn�� przepisania do pliku wynikowego danej zmiennej,
nale�y w dyrektywie
subst przypisa�
jej warto�� specjaln�
null. Poza
zmiennymi definiowanymi przez u�ytkownika istnieje
jedna, specjalna zmienna zdefiniowana w skrypcie
docgen:
%proclib% - s�u�y ona do
odwo�ywania si� do plik�w znajduj�cych si� w katalogu
biblioteki procedur (opis:
Sekcja 4.5) i
powinna by� u�ywana zamiast �cie�ek wzgl�dnych w ka�dym
przypadku, w kt�rym konieczne jest odwo�anie si� do
pliku tam�e zlokalizowanego (np. w przy wstawianiu
obrazk�w wsp�lnych dla wielu dokumentacji lub przy
do��czaniu komentarzy z plik�w procedur).