En-tête de documentation XML StyleCop - Utilisation de 3 /// au lieu de 2 //

J'utilise des en-têtes de documentation XML sur mes fichiers C# pour transmettre la règle StyleCop SA1633.En-tête de documentation XML StyleCop - Utilisation de 3 /// au lieu de 2 //

Actuellement, je dois utiliser la règle de 2 commentaires slash pour permettre à StyleCop de reconnaître l'en-tête. par exemple:

// <copyright file="abc.ascx.cs" company="MyCompany.com"> 
//  MyCompany.com. All rights reserved. 
// </copyright> 
// <author>Me</author>

Cela fonctionne bien pour StyleCop, mais je voudrais utiliser la règle des commentaires 3 slash pour permettre visual studio de comprendre les commentaires que XML et fournir les fonctionnalités XML (surlignage, indentation automatique, etc.)

Le problème est que lorsque vous utilisez 3 barres obliques, StyleCop ne voit plus l'en-tête et lance l'avertissement SA1633.

Est-il possible de configurer stylecop pour comprendre que l'en-tête est contenu dans XML en utilisant 3 barres obliques?

Merci,

Adam

Source

2010-03-17 Adam Jenkin

Je n'ai pu trouver la documentation sur le format de l'en-tête et comment configurer les éléments à l'intérieur, pas le format du commentaire lui-même. – ChrisF

Vous pouvez créer une règle personnalisée et désactiver l'original en faveur de votre nouveau: http://scottwhite.blogspot.com/2008/11/creating-custom-stylecop-rules-in-c.html

Source

2010-03-17 16:14:05

Merci Leom, je pense que ce sera la solution, il serait bon d'étendre ou de copier le code de la règle SA1633 plutôt que de le réécrire. –

Avez-vous déjà écrit une nouvelle règle pour cela? Ne pas envie de recréer la roue. –

En-tête de documentation XML StyleCop - Utilisation de 3 /// au lieu de 2 //

Répondre

Questions connexes