dynamiczne komentarze

Odpowiedz Nowy wątek
2015-02-04 11:57
gosc_z_pytaniem
0

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.

Pozostało 580 znaków

2015-02-04 12:03
Suchy Suchar
0

śmieci kod? przecież komentarz summary można sobie zwinąć a to normalny sposób zrobienia tego czego chcesz

Pozostało 580 znaków

2015-02-04 12:28
ne0
1

Widziałbym to tak:

  1. stwórz bazę danych z komentarzami, nazwami funkcji itd.
  2. stwórz stronę www która pobierze z bazy danych funkcje i zostawi puste miejsce na wpisanie komentarza.
  3. zatrudnij ludzi do pisania komentarzy (beda operowac na stronie www)
  4. pisząc program wpisuj nazwy funkcji do bazy
  5. 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.


Pomogłem? To dobrze :)

Pozostało 580 znaków

2015-02-04 12:58
Rev
1

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/cor[...]rrent/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ę.

c180e34c64.png


Pozostało 580 znaków

2015-02-04 13:51
1
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.


"HUMAN BEINGS MAKE LIFE SO INTERESTING. DO YOU KNOW, THAT IN A UNIVERSE SO FULL OF WONDERS, THEY HAVE MANAGED TO INVENT BOREDOM."

Pozostało 580 znaków

2015-02-04 13:55
gosc_z_pytaniem
0

Dzięki za odpowiedzi. Przekonaliście mnie :-)

Pozostało 580 znaków

Odpowiedz
Liczba odpowiedzi na stronę

1 użytkowników online, w tym zalogowanych: 0, gości: 1, botów: 0