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).