Program do tworzenia dokumentacji funkcjonalności klas

0

Chodzi mi o taki program, w którym kliknę dodaj klasę - wpisze nazwę. Mogę potem dodać opis co ta klasa robi.
Analogicznie moge dodawać inne rzeczy jak metody, pola itp.

Potem mogę to jakoś łatwo przeglądać, lub wygenerować pdf albo cokolwiek.

Nie chodzi mi tu o narredzie generujące dokumentację z kodu źródłowego - kod chcę mieć przejrzysty.

Jest takie coś?

0

Doxygen

0

Z tego co widzę, program generuje HTML z kodu źródłowego, a napisałem, że nie o to mi chodzi.

Poza tym zamiast polskich liter są jakieś krzami, mimo UTF-8 opcjach.

0

Doxygen generować może HTML, CHM, ManPages albo pliki LaTeXu, który można skompilować do PDF. Ma wszystko, czego Ci potrzeba, poza możliwością "wyklikania klasy".

Nie chodzi mi tu o narredzie generujące dokumentację z kodu źródłowego - kod chcę mieć przejrzysty.

Kod dobrze udokumentowany komentarzami z pewnością jest przejrzysty. ;) A właśnie z komentarzy Doxygen generuje dokumentację.

Poza tym takie narzędzie, o jakim mówisz, nie ma większego sensu -- zupełne oddzielenie dokumentacji od kodu źródłowego powoduje sieczkę, której nie da się ogarnąć, a dokumentacja przy każdej edycji kodu staje się nieaktualna.

0

No wiem, ale nie lubie komentarzy dluzszych niz jedna linijka :)

No trudno...

Swoja droga, jak nie ma programu co mozna sobie klasy wyklikac, to jak np zrobic dokumentacje z obrazkami albo animacjami itp, jezeli
chce sie ukazac dzialanie jakiejs skomplikowanje funkcji matematycznej?

Troche dziwne, ze nie ma takiego programu :/

0

Być może chodzi Ci o coś w rodzaju diagramów UML?
http://en.wikipedia.org/wiki/Unified_Modeling_Language

0

Skoro nie lubisz komentarzy dłuższych niż linijka to zaopatrz się w IDE, który pozwala na ukrywanie bloków kodu.

0

Diagramy sa w sumie niepotrzebne. Pracuję w VS 2010. Chcialem po prostu dokumentacje trzymac w innym pliku.

Najlepszym rozwiazaniem bylo by dla mnie cos takiego:
Plik Punkt.cs

/// <doc-id>54545</doc-id>
public void Obróć (Punkt pBazowy, double pRadiany)
...

i gdzieś np w pliku Punkt.docum...

<summary>Bla bla bla bla</summary>

...

Ale widze, ze chyba czegos takiego nie znajdę.

0

Jak nie nauczysz się korzystać z wyszukiwarki to niczego nie znajdziesz.

http://msdn.microsoft.com/en-[...]y/9h8dy30z%28v=VS.100%29.aspx

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