SebElectronic

DescProject

Présentation :

Il est toujours important de bien documenter le code quand nous développons, soit pour permettre à quelqu’un de le relire facilement ou tout simplement être en mesure de s’y retrouver lorsqu’on revient sur le sujet après un long moment.

En plus de la documentation des fonctions, variables etc, renseigner l’entête des fichiers peut également paraitre fort utile pour décrire le rôle du fichier, son auteur et les différentes modifications apportées.

Par contre il est parfois fastidieux de créer cet entête.
J’ai développé DescProject pour cela.

DescProject est une application en ligne de commande qui permet de parcourir le code source, de rechercher certaines balises spécifiques et de les remplacer par le texte correspondant. Le texte correspondant étant stocké dans un fichier contenant l’ensemble des informations.

Ainsi la balise $AUTHOR$ indique au logiciel qu’il faut insérer ici l’auteur du fichier (mentionné dans le fichier de configuration).

DescProject est développé sous Lazarus.
je vous mets à disposition la version Windows.

Caractéristiques :

Les caractéristiques de DescProject sont les suivantes :

Parcours récursif des dossiers.
Prise en charge des langages :
1. C : fichiers *.c et *.h
2. Pascal : fichiers *.pas, *.inc, *.lpr
3. Basic : fichiers *.bas
4. Batch (scripts windows) : fichiers *.bat
5. Shell (scripts Linux) : fichiers *.sh
6. Arduino : fichiers *.ino;*.cpp;*.h