 |  |
Dokumentace javových programů
Základním a standardním prostředkem je tzv. dokumentace API
Dokumentace je naprosto nezbytnou součástí javových programů.
Rozlišujeme dokumentaci např. instalační, systémovou, uživatelskou, programátorskou...
Zde se budeme věnovat především dokumentaci programátorské, určené těm, kdo budou náš kód využívat ve svých programech, rozšiřovat jej, udržovat jej. Programátorské dokumentaci se říká dokumentace API (apidoc, apidocs).
Při jejím psaní dodržujeme tato pravidla:
Dokumentujeme především veřejné (public) a chráněné (protected) prvky (metody, proměnné). Ostatní dle potřeby.
Dokumentaci píšeme přímo do zdrojového kódu programu ve speciálních dokumentačních komentářích vpisovaných před příslušné prvky (metody, proměnné).
Dovnitř metod píšeme jen pomocné komentáře pro programátory (nebo pro nás samotné).