StyleCop SA1638

Question

Używam StyleCop w VS2008. Otrzymuję ten błąd:

SA1638: Atrybut pliku w znaczniku copyright nagłówka pliku musi zawierać nazwę pliku.

Oto mój nagłówek.

// <copyright file="AssemblyInfo.cs" company="company"> 
// Copyright (c) company. All rights reserved. 
// </copyright> 
// <author>me</author> 
// <email>me@me.com</email> 
// <date>2010-03-04</date> 
// <summary>blah blah.</summary> 

Podejrzewam, że problem polega na tym, że mój plik AssemblyInfo.cs znajduje się w folderze Właściwości. Jakieś wskazówki, w jaki sposób mogę naprawić to ostrzeżenie bez uciszania StyleCop?

Answer 1

Wybierz plik w oknie Solution Explorer, kliknij prawym przyciskiem myszy okno Właściwości, skopiuj tekst w obszarze "Nazwa pliku" i wklej go do nagłówka.

Katalog Właściwości nie powinien mieć znaczenia, zakładam, że gdzieś tam masz literówkę.

Dodawanie:
Jeśli to nie zadziała, to aby to naprawić, musisz przenieść go na wyższy poziom.
Skopiuj cały projekt do nowego rozwiązania, przeskanuj ponownie za pomocą StyleCop.
Usuń wszystkie niepowiązane pliki, przeskanuj ponownie za pomocą StyleCop.
Usuń cały kod w pliku problemu, z wyjątkiem nagłówka, przeskanuj ponownie za pomocą StyleCop.
Jeśli problem zniknie gdzieś po drodze, byłoby to naprawdę dziwne.
Jeśli problem nie zniknie, to masz próbkę, którą można odtwarzać!

Zip się, że próbki i dołączyć go do nowej pozycji praca tutaj: http://code.msdn.microsoft.com/sourceanalysis/WorkItem/List.aspx

Given trochę czasu, prawdopodobnie będzie nowe wydanie, aby naprawić ten błąd. 8)

Answer 2

Mam następujący dla pliku AssemblyInfo.cs w folderze Właściwości:

// <copyright file="AssemblyInfo.cs" company="company"> 
// product 
// Copyright (c) 2004-2010 
// by company (http://www.example.com) 
// </copyright> 

I nie ma żadnych problemów z tym. Czy jesteś pewien, że nazwa pliku jest poprawna (może obudowa jest wyłączona?) I że nie masz żadnego nieprawidłowego pliku XML (być może nazwa handlowa w nazwie firmy)?

Answer 3

Powód jest taki, że nazwa pliku różni się od nazwy klasy w tym pliku. Ustaw nazwę pliku i nazwę klasy tak, aby rozwiązać ten problem.

Answer 4

Najprawdopodobniej problem to nazwa pliku, a nazwa klasy jest inna. Jeśli możesz zaktualizować klasę jako częściową, ten błąd nie będzie wyświetlany z StyleCop.

Answer 5

Według StyleCop Dokumentacji, to w jaki sposób można obsłużyć AssemblyInfo.cs dziś:

plik, który jest całkowicie automatycznie wygenerowany przez narzędzie, a które nie powinny być sprawdzone lub wymuszane przez StyleCop, może zawierać "Automatycznie generowany" nagłówek zamiast standardowego nagłówka pliku. Spowoduje to, że StyleCop zignoruje plik. Tego typu nagłówka nigdy nie należy umieszczać na wierzchu ręcznie zapisanego pliku kodu.

// <auto-generated /> 
namespace Sample.Something 
{ 
    // The contents of this file are completely auto-generated by a tool. 
}