SZARP PLC HOWTO | ||
---|---|---|
Poprzedni | Rozdział 13. Automatycznie generowana dokumentacja do programów technologicznych przy użyciu skryptu docgen | Następny |
Z uwagi na to, iż wiele elementów programów technologicznych działających w różnych systemach jest wspólnych, powstała możliwość dołączania komentarzy z zewnętrznych plików. W ramach sekcji ogólnej komentarza, możliwe jest dołączanie dwóch rodzajów komentarzy: sekcji ogólnej z zewnętrznego pliku (opis: Sekcja 13.2.10) oraz sekcji komentarzy dołączalnych (opis: Sekcja 13.2.11) z zewnętrznego lub tego samego pliku.
Dołączenie komentarza ogólnego (wszystkich sekcji w kolejności ich występowania) z innego pliku można zrealizować dyrektywą:
<!-- komentarz - include(ścieżka_względna_do_pliku) -->Dołączanym plikiem może być zarówno inny program technologiczny, jak i oddzielny plik tekstowy zawierający komentarz.
Dołączenie sekcji komentarzy dołączalnych z innego pliku można zrealizować za pomocą dyrektywy:
<!-- komentarz - include(ścieżka_względna_do_pliku, nazwa_sekcji) -->W szczególności, jeśli zamiast ścieżki względnej do zewnętrznego pliku podana zostanie nazwa aktualnego pliku, dołączona zostanie odpowiednia sekcja z aktualnego pliku.
Poprzedni | Spis treści | Następny |
Sekcja komentarzy dołączalnych | Początek rozdziału | Wstawianie formuł matematycznych |