Czy są jakieś narzędzia, które pozwalają na wstrzyknięcie komentarzy XML w czasie kompilacji?
Tworzę bibliotekę, która będzie używana przez innych programistów. Chcę aby przy wielu metodach użytkownikowi pojawiał się komentarz w VS. Oczywiście mogę każdą metodę komentować, ale to bardzo śmieci kod.
Widziałem w niedawno udostępnionym kodzie .NETa, że nie wszystkie metody i właściwości są komentowane XMLem w kodzie, a jednak używając .Net-owych klas, widzimy że dla wszystkich metod, klas, właściwości, etc. istnieją komentarze.
śmieci kod? przecież komentarz summary
można sobie zwinąć a to normalny sposób zrobienia tego czego chcesz
Widziałbym to tak:
- stwórz bazę danych z komentarzami, nazwami funkcji itd.
- stwórz stronę www która pobierze z bazy danych funkcje i zostawi puste miejsce na wpisanie komentarza.
- zatrudnij ludzi do pisania komentarzy (beda operowac na stronie www)
- pisząc program wpisuj nazwy funkcji do bazy
- na samym końcu napisz programik do przelatywania po wszystkich plikach z solucji i edytowaniu ich tam gdzie jest odpowiednia funkcja
:D
a może i są do tego jakieś narzędzia ;) ale nie wiem.
Nie ma absolutnie niczego złego w dużej ilości komentarzy.
Spójrz jak np. wygląda to w samym BCL: https://github.com/dotnet/corefx/blob/master/src/System.Collections.Concurrent/src/System/Collections/Concurrent/ConcurrentDictionary.cs
Czy są jakieś narzędzia, które pozwalają na wstrzyknięcie komentarzy XML w czasie kompilacji?
W rzeczywistości dzieje się rzecz odwrotna: podczas kompilacji komentarze XML są wycinane z plików .cs i umieszczane w osobnych plikach XML (które potem parsuje sobie Visual Studio). Niby mógłbyś wszystkie komentarze trzymać oddzielnie, już w formacie tego zewnętrznego pliku, ale ja w tym sensu nie widzę.
Rev napisał(a):
Nie ma absolutnie niczego złego w dużej ilości komentarzy.
Pod warunkiem, że są aktualne i nie opisują oczywistych rzeczy, dublując to, co wprost wynika z kodu.
Dzięki za odpowiedzi. Przekonaliście mnie :-)