Article complet: Code Header Designer

07/09/2009

19:15:13, Catégories: C#, Articles, Divers, 616 mots

, laedit

Code Header Designer

J'ai découvert ce week end une application assez sympathique. Elle n'a qu'un seul but mais le fait bien, elle permet de définir un header et un footer à rajouter/remplacer à des fichiers de codes.

Certes, ce n'est pas une chose que l'on fait souvent, mais quand on prend l'habitude de partager son code, c'est toujours bien de laisser une trace. Et même pour soi, garder certaines informations en entête peut être utile.

[Suite:]

Présentation

En premier lieu, l'utilisateur va définir un header via un template, comme celui-ci par exemple :
/* ---------------------------------------------------------------------------- * [COMPANY NAME] * ---------------------------------------------------------------------------- * [PRODUCT NAME] * ---------------------------------------------------------------------------- * File: [AUTO:FILE] * Author: [AUTO:AUTHOR] * ---------------------------------------------------------------------------- */

Entre crochet, ce sont des champs remplaçables. On définira donc par la suite leur valeur.
Les champs commençant par 'AUTO:' sont des champs automatiques : ils seront automatiquement remplacés par le programme, sans que l'utilisateur ai besoin de définir une valeur de remplacement.

De base, on dispose de deux champs auto :
- File qui va être remplacé par le nom du fichier
- Author qui va être remplacé par le nom d'utilisateur windows

Ensuite, on va donc définir les champs à remplacer via un DataGridView :
DataGridView ReplaceFields

Il faut maintenant sélectionner les fichiers auxquels on veut appliquer le header. Pour cela, en haut de la fenêtre on va aller cliquer sur le bouton 'Source Directory' pour choisir un dossier. Généralement, ce sera un dossier d'une solution ou d'un projet. Une fois cela fait, on va sélectionner les fichiers via le bouton 'Select files'. Là, on va pouvoir choisir un pattern de recherche des fichiers, qui par défaut recherche les fichier .cs. La liste des sous-dossiers va apparaître dans un TreeView à gauche tandis que les fichiers contenus dans le dossier sélectionné seront listés à droite. Il suffit de cocher un fichier pour l'inclure dans les fichiers auxquels le header sera appliqué. A noter, une option très pratique dans le menu : 'Select all', 'Unselect all'.

Et voilà, on peut maintenant appliquer le header aux fichiers en cliquant sur le bouton 'Go' en bas à gauche de l'application. Une fenêtre de log est même présente afin de savoir si le header à pu être appliqué ou non et dans le dernier cas, de savoir pourquoi.

L'application propose aussi une gestion de sauvegarde et d'ouverture de fichier .headerx, comprenant le template et la liste de correspondances des champs avec leur valeur de remplacement.

Téléchargement : http://code.msdn.microsoft.com/HeaderDesigner

Ajouts

Etant un peu trop limité pour mon utilisation personnelle, j'y ai donc rajouté quelques petites choses.

Champs automatiques :
- Modification_Date : date de dernière modification du fichier.
- Creation_Date : date de création du fichier.
- Solution : nom de la solution si il y en a une.
- Project : nom du projet.
- Namespace : nom du namespace.
- Inherit : nom de la classe mère si il y en a une.
- Implements : nom des interfaces implémenté si il y en a.

Une petite aide à la saisie à aussi été intégrée dans l'éditeur de template, pour ne pas devoir avoir la documentation sous les yeux pour ajouter un champ automatique.
AutoComplete ListBox