SharpComments – kreatywne komentarze

Komentarze są bardzo ważnym elementem kodu źródłowego. Standardowo Visual Studio jest jednak dość ubogie jeżeli chodzi o ich formatowanie. Z jednej strony to dobrze, ponieważ kod źródłowy to nie choinka, którą trzeba przyozdobić kolorowymi szlaczkami, z drugiej czasami przydałoby się zaznaczyć, że jakiś komentarz jest ważniejszy.

Tutaj z pomocą przychodzi SharpComments – dodatek do Visual Studio, który umożliwia zmianę formatowania komentarza w zależności od jego ważności. Typ komentarza, a co za tym idzie jego kolor oraz rozmiar ustalane są na podstawie pierwszych znaków komentarza:

  • + powoduje zwiększenie czcionki
  • ++ powodują jeszcze większe zwiększenie czcionki :)
  • - powoduje zmniejszenie czcionki
  • ! ustawia czerwony kolor czcionki
  • ? ustawia niebieski kolor czcionki

przykładowe komentarze wygladają tak:

SharpComments możemy pobrać ze strony http://visualstudiogallery.msdn.microsoft.com/32b91d27-2a0f-4a4b-9ad3-caed8b4ced4b lub zainstalować bezpośrednio w Visual Studio.

Ostatnio zacząłem korzystać z opcji ” ! “.

Co uważacie o takim formatowaniu komentarzy?

4 Responses

  1. Pingback: dotnetomaniak.pl
  2. sw 17 marca 2011 / 23:22

    Dobry dodatek i czasem się może przydać.

  3. Pingback: dotnetomaniak.pl
  4. 3P 12 kwietnia 2011 / 20:36

    Raczej radziłbym się skupić na pisaniu małych i prostych metod, a nie dodawaniu kolorowych komentarzy. Kiedyś nie pamiętam gdzie przeczytałem. “Kod, który ma dużo komentarzy, to kod nie skończony”.

Comments are closed.