vložil Radek Červinka
2. listopadu 2011 00:02
Součástí XE2 je mimo jiné i lehce očesaná verze Documentation Insight od firmy DevJet. Tento nástroj lze koupit i pro předchozí verze, ale součástí XE2 je verze zdarma.
Cílem je zjednodušení psaní dokumentace v kódu. Nástroj vyvoláme přes CTRL+SHIFT+D (popřípadě přes menu Tools …) stojíce na místě, které chceme dokumentovat (tj. např. metodě). Vyvolaný dialog podporuje základní elementy (kompletní sezname včetně cross referencí je v nápovědě).
Překliknutím zobrazíme náhled
A následně při zastavení nad dokumentovanou částí získáme toto (zároveň lze vidět vygenerované data jako komentáře)
které se dají zavřít:
Jinak je součástí instalace (i předchozí verze) i nástroj "bin\GenDocCLI.exe", který dokáže vygenerovat z projektu dokumentaci. Buďto ho můžete spustit jako commandline program s parametrem projektu (viz. help) nebo z IDE z modelovací části z popupmenu.