Browse thread
MlDoc : extraction automatique de documentation
- Pierre Boulet
[
Home
]
[ Index:
by date
|
by threads
]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
| Date: | -- (:) |
| From: | Pierre Boulet <Pierre.Boulet@l...> |
| Subject: | MlDoc : extraction automatique de documentation |
(english version at the end) bonjour, pour résoudre les problèmes de documentation de gros programmes, il est souvent conseillé de mettre le code source et la documentation dans les mêmes fichiers (programation littéraire). L'approche que j'ai utilisée est de placer la documentation dans les fichiers de code. MlDoc est un programme qui extrait les commentaires de documentation (compris entre les balises « (*TeX » et « *) ») écrits en LaTeX et formatte le reste du fichier comme du code. MlDoc utilise des variations de polices de caractères et des couleurs pour mettre en valeur les mots clés, chaînes de caractères, commentaires, définitions de valeurs et éléments de préprocessing par camlp4. Il peut aussi générer automatiquement des titres de sections pour chaque fichier traîté. MlDoc est conçu pour produire des fichiers qui sont avantageusement traduits en html par HeVeA. Pour plus d'informations sur les possibilités de MlDoc, voir l'url ci-dessous. J'ai le plaisir de rendre un petit quelque chose à la communauté Caml qui m'a tant apporté; MlDoc peut être trouvé à l'url : http://www.lifl.fr/~boulet/softs.html En espérant que ce programme sera utile à quelqu'un. -------------------- English version --------------------- To solve documentation problems for large projects, it is often advised to keep together source code and documentation (eg: litterate programming). I have choosen to write the documentation inside the code files. The program MlDoc extracts the documentation comments (between the "(*TeX" and "*)" marks) written in LaTeX and formats the rest of the file as code. MlDoc highlights keywords, strings, comments, value definitions and preprocessing elements (by camlp4). It can also automatically generate section titles for each file. MlDoc produces files that look good when translated to html by HeVeA. For more information on MlDoc's features, follow the url below. It's my pleasure to give back a little something to the Caml community which gave me so much. MlDoc can be download at: http://www.lifl.fr/~boulet/softs.html I hope someone will find it usefull. -- Pierre.