Natural Docs
Natural Docs est un outil permettant de générer automatiquement
de la documentation à partir de code source Ada.
Natural Docs est un générateur de documentation pour du code
source, écrit en Perl. Il parcourt le code afin de trouver
des commentaires marqués spécialement et les utilise pour
créer une documentation indépendante. Il est disponible
gratuitement et sous forme de logiciel libre (licence GPL).
Il est écrit en Perl.
Philosophie
Les deux principes fondateurs de Natural Docs sont:
- Les commentaires doivent rester aussi lisibles et naturels que possible (d’où le nom, Natural Docs). Les marqueurs obligatoires sont aussi légers que possible. Notamment, il n’y a pas de marqueur tel que =head1 (comme dans POD) ou @param (comme dans JavaDoc). La structure est minimale et quasi-transparente. Les commentaires dans les fichiers sources sont aussi lisibles que la documentation générée.
- Le programme doit être aussi automatique et non-intrusif que possible.
Natural Docs supporte un grand nombre de langages, dont Ada.
Laissez un commentaire