dotnetomaniak.pl - Artykuły z tagiem GhostDoc

Pod jednym z ostatnich postów wywiązała się krótka dyskusja na temat komentowania kodu i postanowiłem poczynić follow-up w postaci osobnej notki. Mam cały czas na myśli oczywiście komentarze wyjaśniające działanie kodu a nie zakomentowany kod. Zakomentowany kod powinien być usuwany na poziomie repozytorium w momencie check-ina i problem mielibyśmy z głowy. Na ten temat nawet nie będę się rozwodził.

Kilka słów komentarza o… komentarzach | Maciej Aniserowicz o programowaniu

Sztuka programowania 4319 dni, 14 godzin, 40 minut temu psz750 172 źrodło rozwiń

W kodzie C# możemy tworzyć komentarze przy pomocy XML. Na podstawie tych komentarzy można później wygenerować pliki z dokumentacją przy pomocy odpowiednich narzędzi. Zawsze jednak strasznie nie chciało mi się  pisać komentarzy do kodu. Zajęcie to jest nudne i czasochłonne (czasem nic po prostu nie przychodzi do głowy). Z GhostDoc (dodatek do Visual Studio) wszystko może ulec zmianie. Narzędzie to służy do generowania komen...

Dziel się z innymi:
pisanie dokumentacji z GhostDoc « Damian Antonowicz

Narzędzia 5158 dni, 22 godziny, 20 minut temu gordon_shumway 94 źrodło rozwiń