Ich habe eine Dokumentation Header für eine Klasse, die Wörter hat, die nicht korrekt nach stylecop geschrieben werden. Sie sind Code-spezifisch und müssen dabei sein.Wie stylecop Fehler zu unterdrücken SA1650 (falsch geschriebene Wörter)
Fehler SA1650: CSharp.Documentation: Die Dokumentation Text innerhalb die Zusammenfassung Tag falsch geschriebene Wörter enthält: ...
Ich wünsche den Fehler zu unterdrücken. Wie kann ich das machen?
Ich habe die erforderliche Kategorie und CheckId
/// <summary>
/// ... documentation with misspelled words ...
/// </summary>
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public class Program
{
// ...
}
SuppressMessage Mit Warnungen auf Worte zu unterdrücken, die domänenspezifische sind eine Lösung. Sie müssen das Attribut jedoch allen Methoden hinzufügen, die diese Wörter enthalten.
Es ist IMHO besser, ein Benutzerwörterbuch zu implementieren, so dass alle Instanzen dieser Wörter von den Analysatoren ignoriert werden und niemals Warnungen generieren.
https://msdn.microsoft.com/en-us/library/bb514188.aspx beschreibt den Prozess des Hinzufügens eines benutzerdefinierten Wörterbuchs - siehe das Ende des Artikels und achten Sie besonders auf die Build-Aktion. Der Artikel beschreibt auch die Struktur des XML und was zu tun ist, um bestimmte Warnungen zu lösen.
Haben Sie diese Antwort versucht https://stackoverflow.com/questions/3287656/how-to-suppress-a-stylecop-warning? –
Es ist ein anderer stylecop Fehler, ich möchte wissen, wie man diese spezifische Nachricht unterdrückt –
Sie müssen die Werte von der Antwort durch Ihre eigenen ersetzen. Ich denke, der erste Parameter wäre etwas wie CSharp.Documentation oder Microsoft, StyleCop.CSharp.Documentation. Der zweite wäre SA1650: ElementDocumentationMustBeSpelledCorrectly –