SZARP PLC HOWTO
PoprzedniRozdział 13. Automatycznie generowana dokumentacja do programów technologicznych przy użyciu skryptu docgenNastępny

13.2. Dokumentacja programów technologicznych

Aby dokumentacja tworzona na podstawie programów technologicznych została prawidłowo wygenerowana, pliki źródłowe programu technologicznego muszą posiadać odpowiednio zaznaczone komentarze. Komentarze te zostały podzielone na odpowiednie sekcje, z których każdą identyfikuje unikalny znacznik. Wyróżnione zostały następujące sekcje:

13.2.1. Wykorzystanie preprocesora języka C

Pierwszą fazą wykonywaną przez skrypt docgen.pl jest "przepuszczenie" źródeł programu technologicznego przez wbudowany w kompilator gcc preprocesor języka C ze zdefiniowaną dyrektywą DOCGEN oraz opcjonalnie dyrektywą zawartą w pliku ports (patrz opis parametru opt_directiveX w Sekcja 13.2.15). Następnie są wykonywane operacje arytmetyczne na odnalezionych stałych liczbowych. Wszystkie opisane dalej operacje są wykonywane na tak przetworzonych źródłach; pozwala to na stosowanie np. takich konstrukcji: 

#define ILOSTA	15
.......
#ifdef DOCGEN
abc = tabwfsta[ILOSTA - 1];		/* kod dostępu */
#endif
Instrukcja przypisania zostanie zignorowana podczas normalnej kompilacji (o ile nie kompilujemy ze zdefiniowaną dyrektywą DOCGEN), w związku z czym zmienna abc nie musi być zadeklarowana w programie, a wyrażenie ILOSTA - 1 - zostanie wyliczone i zastąpione liczbą 14 (patrz też Sekcja 13.2.2).

PoprzedniSpis treściNastępny
Automatycznie generowana dokumentacja do programów technologicznych przy użyciu skryptu docgenPoczątek rozdziałuSekcja parametrów programowalnych stałych