Interní dokumentace - Internal documentation
![]() | tento článek ne uvést žádný Zdroje.Prosince 2009) (Zjistěte, jak a kdy odstranit tuto zprávu šablony) ( |
Počítač software se říká, že má Interní dokumentace pokud jsou poznámky týkající se toho, jak a proč fungují různé části kódu, zahrnuty do zdrojový kód jako komentáře. Často se kombinuje se smysluplným proměnná jména s úmyslem poskytnout potenciálním budoucím programátorům prostředky k pochopení fungování kódu.
To kontrastuje s externím dokumentace, kde programátoři uchovávají své poznámky a vysvětlení v samostatném dokumentu.
Interní dokumentace je stále populárnější, protože ji nelze ztratit, a každý programátor pracující na kódu je okamžitě informován o své existenci a má ji snadno k dispozici.