Kontrola Javadoc dokumentace
Tento příklad popisuje využití akce pro kontrolu Javadoc dokumentace. Javadoc je softwarová utilita pro automatické generování dokumentace k Java programu. Doména popisuje rozbalení odevzdaného souboru, kontrolu dokumentace a vyhodnocení.
Doména
Budeme předpokládat, že studenti odevzdávají program zabalený v archívu zip nebo jar. Proto je nejprve nutné vytvořit krok pro rozbalení archívu, poté krok pro kontrolu dokumentace a nakonec krok pro vyhodnocení získaných výsledků.
Rozbalení archívu
Krok rozbal má podmínku typu Vždy, tzn. akce se provede pokaždé. Jako akce je použita vlastní akce Rozbal ZIP. Proměnná pro archív není vyplněná, bude se tedy brát odevzdávaný soubor. Nakonec jen nastavíme název pro cílový adresář.
Kontrola dokumentace
Dokumentace je kontrolována nejprve z hlediska struktury, tj. je kontrolováno zda je v programu soubor doc a zda obsahuje všechny povinné soubory (automaticky vygenerované). Poté je kontrolováno kolik procent kódu (tříd a metod) obsahuje dokumentaci.
Podmínka je opět nastavena na Vždy, akci je vlastní akce Kontrola Javadoc. Jako rodičovský adresář zadáme název adresáře, který jsme zvolili v předchozím kroku. Zadáme názvy pro proměnné pro uchování výsledeku a zprávu o výsledku, nakonec nastavíme požadované procento okomentovaného kódu na 60%.
Vyhodnocení
Nyní můžeme použít výsledek validace a nechat v případě chyby vypsat nastavenou zprávu. Podmínkou je vlastní skript, ve kterém zjistíme, zda nastala při kontrole dokumentace chyba, tj. zda je proměnná result nastavena na false.
Pokud je podmínka splněna, vložíme do výstupu validace chybu obsahující zprávu nastavenou při kontrole dokumentace.
Testování domény
Takto nastavenou doménu můžeme ostestovat zkušebním odevzdáním souboru. Výsledek validace bude zobrazen na samostatné stránce.
Chyba struktury
Pokud odevzdáme soubor, kde nebude dodržena správná struktura dokumentace, může výsledek validace vypadat např. takto:
Chyba nedodržení struktury nenastane, pokud student nechal dokumentaci automaticky vygenerovat nástrojem Javadoc. Chyba může nastat zásahem do vygenerovaných souborů.
Chyba počtu komentářů
Pokud odevzdaný program obsahoval menší množství komentářů než bylo požadováno, může výstup validace vypadat např. takto:
