V praxi se můžeme často setkat s projekty, které mají velice malou, ne-li žádnou dokumentaci. Vývojáři často označují tvorbu dokumentace za zbytečnou, ale opak je pravdou. Je pravda že udržování kvalitní a aktuální dokumentace k projektu je bohužel značně časově náročné, pokud se neví jak na to...

Jakýkoliv Word dokument, či externí soubor je dříve nebo později odsouzený k zániku. Tajemství úspěchu je v začlenění textu dokumentace přímo do zdrojových kódů. Na správně okomentované zdrojové kódy lze pak použít nástroje pro automatické vygenerování dokumentace např. ve formátu CHM. ´

Mezi velice kvalitní nástroje pro generování dokumentace patří program Doc-o-matic. Na homepage se mimojiné autoři chlubí tím, že byl použit pro generování helpu pro CodeGear Delphi2007. Jediné negativum tohoto programu je v jeho ceně, která není nikterak malá.

Pro ty co nechtějí utrácet peníze, existuje free opensource alternativa DelphiCodeToDoc. DelphiCodeToDoc spoléhá na to, že zdrojové kódy správně okomentujete a nikterak vám s tím nepomůže. Vytvoří pouze stromovou strukturu objektů s popisem jaké informace u nich postrádá. Formát komentování je stejný jako u projektu JavaDoc. Podporováno je ale pouze několik hlavních značek. Přesný popis naleznete na stránce projektu DelphiCodeToDoc.

Jakmile se naučíte při programování vkládat komentáře výše zmíněným způsobem, bude pro vás generování dokumentace příjemnou a snadnou činností. Aktuální dokumentace pak ušetří spoustu práce nejen vám ale i vašim kolegům. Proto doporučuji překonat počáteční neznámo a odpor k tvorbě dokumentace a vrhnout se s chutí do toho!