tworzenie dokumnetacji w C#

0

Witam. Czy może mi tkoś opisc jak sie tworzy dokumentacie (chyba chodzi o te szare komentarze w kodzie) w C# w VS?? Z góry dzieki.

0

Najlepiej włączyć sobie w opcjach projektu wymóg pisania komentarzy do każdego obiektu/metody/właściwości publicznej. To bardzo pomaga w dyscyplinie przy dużym projekcie - mówię z doświadczenia :)

Następnie wystarczy napisać 3 slashe (///) nad linijką z deklaracją metody, klasy czy innego elementu by VS stworzyło szablon gotowy do wypełnienia.

Takie komentarze zawarte są wewnątrz pliku .exe i z niego tworzona jest dokumentacja.
Ja używam do tego celu programu NDoc i bardzo mi on pasuje ale może są ciekawsze rozwiązania.

0

Oprócz NDoc, to polecam jeszcze Sandcastle, z tym, że trzeba się napracować z plikami zanim otrzymamy dokumentację (ale są odpowiednie skrypty, GUI i inne wodotryski).

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