9.1 Commentaires C# et commentaires côté serveur pour les balises

Il est certainement superflu de préciser pourquoi vous devez absolument commenter vos programmes. 

La quantité de commentaires à ajouter au code dépend du contexte. Afin de vous aider à déterminer si votre code est suffisamment commenté, on utilisera le comparatif suivant : dans le code C#, environ 1 ligne sur 10 devrait contenir un commentaire.

Voici les différentes techniques qui s'offrent à vous pour commenter votre code.

Dans le code C#

Les commentaires dans le code C# sont entrés avec les symboles habituels.

Ex :

Dans le fichier de balises

Il est également possible de mettre des commentaires dans le fichier .aspx contenant les balises. On utilisera les commentaires côté serveur. Ces commentaires ne seront pas visibles sur la page Web ni dans la source sur le navigateur :

On évitera les commentaires HTML. En effet, bien qu'ils n'apparaissent pas sur la page Web, on pourra les voir en consultant le code source sur le navigateur :

Pour plus d'information

VINCENT Lainé. « Bien commenter et documenter son code en C# ». Developpez.com. http://vincentlaine.developpez.com/tuto/dotnet/comdoc/

« Introduction aux expressions inline ASP.NET dans le .NET Framework ». Support Microsoft. http://support.microsoft.com/kb/976112

« Embedded Code and Inline Server Tags ». Ahmed Moosa. http://weblogs.asp.net/ahmedmoosa/archive/2010/10/06/embedded-code-and-inline-server-tags.aspx