Witam,
znacie jakieś dobre środowisko do automatycznej dokumentacji projektu Visual Studio?
Słyszałem, że są programy, które na podstawie kodu tworzą dokumentację - w tym diagramy klas itp - istnieją w ogóle takie?
Jeśli się nie mylę, słyszałem ze Microsoft Visio ma taką opcję.
Z góry dzięki za podpowiedzi :)
Generalnie, aby dokumentować swój kod powinieneś umieszczać komentarze w specjalnej formie nad procedurami i obiektami. W C# o ile dobrze pamiętam wygląda to tak:
///<summary>
///Co robi procedura
///</summary>
///<param "nazwa1">po co jest ten parametr i jaki ma być</param>
///<return>co zwraca procedura</return>
VisualStudio 2010 autouzupełnia odpowiednie rzeczy w komentarzu kiedy trzykrotnie użyjesz znaku "/"
Dobry artykuł jest tutaj
Do wygenerowania dokumentacji dobry jest program doxygen (oczywiście jeżeli w powyższy sposób dodasz komentarze do kodu). Jest darmowy i radzi sobie także z innymi językami.
ok, dzięki - Doxygena już chyba gdzieś mijałem
a jeśli chodzi o diagramy klas i inne GRAFICZNE reprezentacje kodu? jest jakiś automat jak Doxygen?
W VisualStudio możesz sobie automatycznie wygenerować diagram klas. Robi się to w następujący sposób:
hm, w tym problem, że w opcji Add new item nie widzę ClassDiagram :?
Miał ktoś podobny problem?
-- dobra znalazłem: należy zaznaczyć jeden z projektów w rozwiązaniu i kliknąć ikonkę powyżej nazwaną 'View Class Diagram', wtedy do projektu dodaje się plik .cd :)
Dzięki!
LukTar napisał(a)
W VisualStudio możesz sobie automatycznie wygenerować diagram klas.
Tylko chyba nie w każdej wersji VS, w szczególności nie w Express, no i nie jest to diagram klas zgodny UML.
shao napisał(a)
Słyszałem, że są programy, które na podstawie kodu tworzą dokumentację - w tym diagramy klas itp - istnieją w ogóle takie?
Tak, programy CASE tak potrafią, np. Enterprise Architect, ale niektóre darmowe typu StarUML czy ArgoUML ponoć też.
tej funkcji chyba nie ma w wersji express, dopiero w standard
No to w takim razie sory, przyzwyczaiłem się do VS Professional, szczególnie, że jako student mam go za darmo. No ale znalazł, to może akurat trafiłem :).
LukTar napisał(a)
No to w takim razie sory, przyzwyczaiłem się do VS Professional, szczególnie, że jako student mam go za darmo. No ale znalazł, to może akurat trafiłem :).
znalazłem, ale to nie to samo co w wersjach 'nie-studenckich' - też takiej używam, akademia MSDN daje spore możliwości :)
Mijałem też gdzieś Enterprise Architect, poszukam i pobawię się automatyczną dokumentacją - opowiem później