Donnez à vos commentaires la visibilité qu’ils méritent
L’un des seuls reproches que je peux faire à Visual Studio est la présence de commentaires en XML… Déjà qu’ils n’étaient jamais mis à jour en texte à peu près libre, je ne vois pas qui prendra le temps de jouer avec des tags XML en plus (sauf les rares développeurs d’API, bien sûr !).
Cela dit, si vous trouvez comme moi que les commentaires ne sont pas assez mis en évidence dans Visual Studio, vous pouvez toujours faire comme moi. Lire ci-dessous pour la suite.
Les commentaires ont beau être en vert par défaut, je les trouve discrets. J’aime bien les mettre en évidence en utilisant un fond coloré.
Commentaires XML. Ces commentaires sont difficiles à lire, même lorsqu’on fait un effort de mise en page… Or, ceci tient en partie aux couleurs : rien ne permet de distinguer les attributs (comme le nom des paramètres) des tags : tout est gris. En choisissant un fond coloré et en modifiant la couleur des attributs, ça s’améliore un brin :
Commentaires standards. Placés en bout de ligne, ces commentaires ne sautent pas aux yeux, c’est le moins qu’on puisse dire. J’utilise donc un fond vert :
Comment modifier la couleur des commentaires (VS2005)
- Ouvrir la fenêtre Options (Tools > Options…).
- Dans l’arborescence de gauche, choisir Fonts and Colors.
- Dans la liste Display items, choisir XML Doc Attribute.
- Couleur du texte : Red.
- Couleur du fond :
- Cliquer sur le bouton Custom…
- Entrer les valeurs RGB suivantes : 255, 255, 198.
- Dans Display items, choisir XML Doc Comment.
- Texte : Green.
- Fond : même jaune que ci-dessus.
- Dans Display items, choisir XML Doc Tag.
- Texte : Default.
- Fond : même jaune que ci-dessus.
- Dans Display items, choisir Comment.
- Texte : Default.
- Fond : Entrer les valeurs RGB suivantes : 202, 255, 202.