Le principe des commentaires automatiques apparu avec C# sur Visual Studio.NET n'existe pas à la base en VB.NET.
Il faut donc utiliser un outil développé par l'équipe de GotDotNet (US). Nous allons voir comment utiliser celui-ci pour générer facilement une documentation standardisée.
Lorsque l'on veut développer une application, il est rapidement obligatoire de commenter son code. Ceci pour plusieurs raisons :
Permettre facilement le travail en équipe
Permettre de se replonger dans son code rapidement même plusieurs mois après
Permettre une lecture aisée du code par toute autre personne
...
Comme me disait un professeur, n'importe qui ne connaissant pas forcément le langage que vous utilisez doit pouvoir ouvrir n'importe quel fichier source et comprendre rapidement le but de chaque fonction. Ceci ne peut donc se faire que par l'utilisation 'abusive' des commentaires.
Le but de cet article est de vous présenter l'outil VBCommenter qui va vous permettre de générer (avec NDoc) les fichiers d'aide que vous pourrez conserver ou redistribuer avec votre projet.
Présentation
VBCommenter est développé par l'équipe de GotDotNet dans le but de permettre aux développeurs VB.NET utilisant Visual Studio.NET 2003 de travailler avec NDoc (de la même façon que les développeurs C#).
En effet, le principe des commentaires automatiques a été ajouté en natif dans C# avec les ///, mais n'existait pas sous VB.NET.
Ainsi dans tout projet C#, on retrouve au dessus de chaque classe et de chaque fonction les blocs ci-dessous :
/// <summary> /// Description résumée de ClassTest. /// </summary> public class ClassTest { ....
Forum |
Actu |
Glossaire |
Codes |
Tips |
Liens |
Livres |
Annuaire
