Documentation de projets en XML

Boulanger, Frédéric; Bourda, Yolaine

Cahiers GUTenberg, no. 35-36 (2000), pp. 15-23.

Le manque de documentation de la plupart des logiciels, et notamment de ceux développés par nos étudiants, nous amène à envisager une approche de la documentation par annotation du code dans les commentaires. Nous généralisons cette approche afin de pouvoir documenter du code en n’importe quel langage, et de créer de la documentation à n’importe quel format. XML est toutefois le format que nous privilégions car ce travail s’inscrit dans un projet plus vaste de traitement des documents.

The lack of documentation in most software projects, and particularly in our students’ projects, lead us to develop a way to document software by annotating it in comments. We generalize this approach to be able to document code in any language and to create documentation in any format. However, XML is our preferred choice since this work is part of a broader document processing project.