Toto rozšírenie umožňuje automatické vytváranie dokumentácie PLC programu, ktorý riadi a obsluhuje zariadenie, alebo z PLC knižnice. Preto sa do programu vkladajú špecifické označenia v komentároch zdrojového kódu na zvýraznenie relevantných informácií a ich formátovanie pre dokumentáciu. Možno tiež odkazovať na iné dokumenty obsahujúce dodatočné informácie.
Keďže dokumentácia je generovaná priamo z kódu riadiaceho programu, možno zabezpečiť, aby aplikačný program a dokumentácia boli konzistentné. Dodatočné úsilie pre vývojárov je malé, pretože pomocou značiek vložených v komentároch môže vývojár píšuci program v TwinCAT 3 napísať vysvetľujúci text priamo do TwinCAT projektu.
Okrem toho sa štruktúra softvéru používa aj na zobrazenie dedičných vzťahov. Generujú sa čiastočné diagramy tried na zobrazenie závislostí prvkov kódu. Obsah dokumentácie sa vygeneruje automaticky, nie je potrebná žiadna ďalšia práca.
Vygenerovaná dokumentácia je rozdelená do jednotlivých sekcií, ktoré sú usporiadané v nasledujúcej hierarchii:
- prehľad (Overview),
- zhrnutie (Summary),
- popis (Description),
- deklarácia (Declaration),
- príklad (Example).
Hierarchia jednotlivých elementov sa riadi pomocou značiek (kľúčových slov) popis (Description), zhrnutie (Summary) a príklad (Example).
V tab. 1 sa nachádza zopár základných značiek na tvorbu a formátovanie generovanej dokumentácie.
| plná forma | skrátená forma | popis |
| <description> </description> | @description | textová časť označená ako popis |
| <summary> </summary> | @summary | textová časť označená ako súhrn |
| <param name=“”> </param> | @param | parameter |
| <h1> </h1> – <h6> </h6> | – | nadpisy do úrovne 6 |
| <note type=“”> </note> | – | definuje bezpečnostné pokyny (Nebezpečenstvo, Varovanie, Poznámka) |
| <image uri=""></image> | – | vloží obrázok |
Tab. 1
Aby boli komentáre z PLC kódu vložené do dokumentácie, je ich zápis doplnený výkričníkom, kde sa pre jednoriadkový komentár použije oddeľovač //! a pre viacriadkový komentár oddeľovač (*!…*).
Keď je projekt dokončený spolu so značkami, môže sa pristúpiť ku generovaniu dokumentácie, kde možno nastaviť výstupný formát a jazyk, ďalej rozloženie definované CSS súborom a cieľovú skupinu (Audience), pre ktorú má byť dokumentácia generovaná.
Po dokončení generovania dokumentácie je priamo vo vývojom prostredí TwinCAT dostupný prehľad výslednej dokumentácie.
Dokumentácia musí zodpovedať aktuálnemu stavu zariadenia. Ak zákazník vykoná nejaké zmeny v PLC programe, tie musia byť zahrnuté aj v dokumentácii. A práve na zabezpečenie aktuálnosti dokumentácie zariadenia môže byť táto dokumentácia generovaná zo súčasného stavu PLC programu.
Vďaka tomuto rozšíreniu dokáže zákazník ušetriť čas a kapacitu na tvorbu dokumentácie a venovať ju ďalšiemu vývoju svojich produktov a zariadení. Navyše, docieli jednotnosť v tvorbe dokumentácie, ak sa na jej tvorbe podieľalo viacero ľudí, prípadne oddelení.
V prípade záujmu možno nájsť ďalšie informácie na stránkach spoločnosti Beckhoff Automation https://www.beckhoff.com/, prípadne v elektronickej dokumentácii k tomuto rozšíreniu dostupnej na https://infosys.beckhoff.com/ v sekcii TE1030|TwinCAT 3 Documentation Generation. Možno sa tiež obrátiť na oficiálne zastúpenie pre Českú republiku a Slovenskú republiku na mailovej adrese info@beckhoff.cz , prípadne info@beckhoff.sk .
Beckhoff Automation, s.r.o.
