Aktuální vydání

celé číslo

04

2024

Průmyslové roboty a automatizace výrobních a montážních linek

celé číslo

Automatické generovanie dokumentácie k softvéru

Dokumentácia je dôležitou súčasťou zariadení. Každé zariadenie alebo výrobok, ktoré sa uvádzajú na trh a do prevádzky, musí podľa zákonných nariadení obsahovať platnú a aktuálnu dokumentáciu. Tvorba dokumentácie stojí čas a peniaze, musí byť konzistentná a mala by vyzerať rovnako, aj keď na nej pracuje viacero ľudí. Z týchto dôvodov spoločnosť Beckhoff pridala nové rozšírenie do svojho softvérového systému TwinCAT s názvom TE1030 – TwinCAT 3 Documentation Generation.

 

Rozšírenie TwinCAT 3 Documentation Generation umožňuje automatické vytváranie dokumentácie programu PLC, ktorý riadi a obsluhuje zariadenie alebo je uložený v knižnici PLC. K tomuto účelu 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. Je tiež možné sa odkazovať na iné dokumenty obsahujúce dodatočné informácie.

Keďže dokumentácia je generovaná pria­mo z kódu riadiaceho programu, je možné 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 projektu TwinCAT.

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 tejto hierarchii:

  • prehľad (Overview),
  • zhrnutie (Summary),
  • popis (Description),
  • deklarácia (Declaration),
  • príklad (Example).

Hierarchia jednotlivých elementov sa ria­di pomocou značiek (kľúčových slov) popis (Description), zhrnutie (Summary) a príklad (Example).

tab. 1 sa nachádza zopár základných značiek pre tvorbu a formátovanie generovanej dokumentácie.

Pre vloženie komentárov z kódu PLC 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č (*!...*).

Príklad použitia značiek v jazyku ST v prostredí TwinCAT pre program MAIN môže vyzerať takto:

 

(*! @summary Program s jednoduchým počítadlom

<description>Toto je program, kde sa bude inkrementovať premenná iCount01 </description> *)

//! @param iCount01 premenná pre inkrementovanie

PROGRAM MAIN

VAR

  btest AT %Q* :BOOL; //! Výstupná testovacia premenná

  iCount2: INT; // Toto je interný komentár, ktorý nebude zobrazený v dokumentácií

END_VAR

 

Keď je projekt dokončený spolu so značkami, môže sa pristúpiť ku generovaniu dokumentácie, kde je možné nastaviť výstupný formát a jazyk. Ďalej sa nastavuje rozloženie definované súborom CSS a cieľová skupina (Audience), pre ktorú má byť dokumentácia generovaná (obr. 1).

Po dokončení generovania dokumentácie je priamo vo vývojom prostredí TwinCAT dostupný prehľad výslednej dokumentácie, viď obr. 2.

Dokumentácia musí odpovedať aktuálnemu stavu zariadenia. Ak zákazník vykoná nejaké zmeny v programe PLC, musia byť zahrnuté aj v dokumentácii. A práve pre zabezpečenie aktuálnosti dokumentácie zariadenia môže byť táto dokumentácia generovaná zo súčasného stavu programu PLC.

Vďaka tomuto rozšíreniu dokáže zákazník ušetriť čas a kapacitu pre tvorbu dokumentácie a venovať ich ď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í, popr. oddelení.

V prípade záujmu je možné nájsť ďalšie informácie na stránkach spoločnosti Beckhoff Automation https://www.beckhoff.com/, popr. v elektronickej dokumentácii k tomuto rozšíreniu dostupnej na https://infosys.beckhoff.com/ v sekcií TE1030 | TwinCAT 3
Documentation Generation. Tiež je možné sa obrátiť na oficiálne zastúpenie pre Česko a  lovenskú republiku na mailovej adrese info.cz@beckhoff.com.

 

(Beckhoff Automation s. r. o.)

 

Obr. 1. Nastavenia pre generovanie dokumentácie

Obr. 2. Náhľad na vygenerovanú dokumentáciu vo vývojom prostredí TwinCAT

 

Tab. 1. Základné značky pre tvorbu a formátovanie generovanej dokumentácie