# Documentation

La documentation appartient malheureusement aux aspects les plus négligés en matière de programmation. Pourtant, une fois correctement configurée et maintenue, la documentation interne et externe fournit une aide des plus précieuses.

La documentation a des facettes multiples. Il y a

- la documentation interne au projet, composée principalement

  - des commentaires dans les fichiers sources / d'en-têtes

  - la documentation de l'&API; interne de votre projet, générée depuis le fichier de programme par des outils spéciaux, &pex; &doxygen;

- la documentation externe au projet, comprenant entre autres

  - la documentation de l'&API; externe &pex; les bibliothèques système courantes (&kde;, &Qt;, &etc;)

  - toute autre documentation (manuels de langages de programmation, informations générales sur le système, articles « how-to »,&etc;)

Toute cette documentation devra être facile à maintenir et à portée de la main, à chaque fois que vous en avez besoin. &kdevelop; a des ressources simplement pour cela.

## Le navigateur de documentation

### Une copie d'écran de l'arborescence de la Documentation