web-dev-qa-db-fra.com

Visual Studio Désactivation de l'avertissement de commentaire XML manquant

J'ai un projet avec plus de 500 Missing XML Comment avertissements. Je sais que je peux supprimer la fonctionnalité de commentaire XML ou coller des extraits de commentaire vides partout, mais je préférerais une solution générique dans laquelle je peux effectuer une modification qui désactive tous les avertissements de ce type.

Ce que je fais tout à l'heure est de mettre

///<Summary>
/// 
///</Summary>

ou

#pragma warning disable 1591

était juste curieux de savoir si cela serait possible.

visual-studio-2010xml-comments
179
Nivid Dholakia

Comme suggéré ci-dessus, en général, je ne pense pas que ces avertissements doivent être ignorés (supprimés). Pour résumer, l’avertissement serait le suivant:

  • Supprimez l'avertissement en modifiant le projet Properties> Build> Errors and warnings> Suppress warnings en entrant 1591
  • Ajouter les balises de documentation XML ( GhostDoc peut être très pratique pour cela)
  • Supprimer l'avertissement via les options du compilateur
  • Décochez la case "Fichier de documentation XML" dans le projet Properties> Build> Output
  • Ajouter #pragma warning disable 1591 en haut du fichier et #pragma warning restore 1591 au fond
288
Gorgsenegger

Désactiver l'avertissement: Accédez aux propriétés du projet (cliquez avec le bouton droit de la souris sur votre projet et choisissez Propriétés dans le menu contextuel). Accédez à l'onglet Générer enter image description here

Ajoutez 1591 à la zone de texte Supprimer les avertissements enter image description here

64
Rao Adnan

Vous pouvez également modifier le fichier .csproj De votre projet pour inclure une balise <noWarn>1591</noWarn> À l'intérieur du premier <PropertyGroup>. Originaire de Article de Alexandru Bucur ici

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    ...
    <noWarn>1591</noWarn>
  </PropertyGroup>
  ...
</Project>
11
DotNetPadawan

Accédez aux propriétés du projet et décochez l'option de génération d'un document XML.

Uncheck XML documentation file

Recompiler et les avertissements devraient disparaître.

9
Chris

Cela aurait été un commentaire, mais je ne pouvais pas l'adapter à la limitation:

J'aimerais les désactiver uniquement pour les importations Reference.cs et WebService. En fait, j'utilise une macro pour le faire dans un fichier. Ouvrez simplement le fichier et exécutez cette macro (testé dans VS2010):

Sub PragmaWarningDisableForOpenFile()
    DTE.ActiveDocument.Selection.StartOfDocument()
    DTE.ActiveDocument.Selection.NewLine()
    DTE.ActiveDocument.Selection.LineUp()
    DTE.ActiveDocument.Selection.Insert("#pragma warning disable 1591")
    DTE.ActiveDocument.Selection.EndOfDocument()
    DTE.ActiveDocument.Selection.NewLine()
    DTE.ActiveDocument.Selection.Insert("#pragma warning restore 1591")
    DTE.ActiveDocument.Save()
End Sub

Il n'y a vraiment aucun moyen de faire cela automatiquement? Vous devrez le refaire chaque fois que le code généré automatiquement annule le fichier.

4
Kjellski