2011-11-17 12 views
8

Używamy ReSharper 6.0 z StyleCop dla ReSharper.ReSharper - jak wyłączyć generowanie nagłówków dokumentacji śmieci w Code Cleanup

Chociaż używamy reguły StyleCop, że członkowie muszą mieć nagłówki dokumentacji, nie chcemy, aby funkcja czyszczenia kodu ReSharpera generowała nagłówki dokumentacji dla nas, ponieważ są one nieuchronnie bzdurne. Złe nagłówki dokumentu są gorsze niż żadne, ponieważ są mniej prawdopodobne, że zostaną zaktualizowane niż dodane w pierwszej kolejności.

Próbowaliśmy wyłączyć ustawienie "Wstaw tekst do dokumentacji i nagłówków plików" w ReSharper => Opcje => Narzędzia => StyleCop, ale krwawe resetuje się po ponownym uruchomieniu Visual Studio.

Jakieś pomysły, w jaki sposób możemy zatrzymać czyszczenie kodu, tworząc nagłówki dokumentacji dla nas?

Odpowiedz

8

ReSharper -> Options -> Tools section -> Code Cleanup -> select StyleCop profile -> Documentation section -> untick 1600.

uniemożliwi nagłówki dokumentacji domyślne tworzone ale StyleCop nadal będzie egzekwować, że powinny one być tam.

+3

Dla mnie, musiałem ustawić '1639: Update file head' na' Nie zmieniaj'. – Iain

+1

Ponadto, jeśli używasz niestandardowego nagłówka pliku i nie chcesz go zastępować standardowym nagłówkiem StyleCop, odznacz "1633-1641: Aktualizuj nagłówek pliku" w obszarze StyleCop -> Dokumentacja. –

0

Drugi krok po zablokowaniu generowania kodu to Usuwanie śmieci. Użyłem wyrażeń regularnych Wyszukaj/Zamień przez studio graficzne.

Regex jest dla nagłówka:

// ---.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n\/\/.*\r\n.*\r\n\/\/.-{116} 

regex Usunąć wygenerowane streszczenia

\s{4}\/\/\/\s<summary>(.*)\r\n.*\r\n.*</summary> 

Uwaga: będzie usunięcie WSZYSTKICH streszczeń, nawet te dobre, więc sprawdź zakres zastępczą przed uruchomieniem go. (git checkout może być twoim przyjacielem ...)

Powiązane problemy