Cześć,
chciałbym wygenerować dokumentację UML z kodu C# w taki sposób, aby można ją było wkleić do dokumentacji w Wordzie na max kilku stronach (czyli odpada olbrzymi schemat przeskalowany np. do 10% lub duży schemat rozbity na kilkanaście czy kilkadziesiąt kartek) i żeby mogła czytelnikowi pomóc w zrozumieniu o co ogólnie chodzi w architekturze solucji (tzn. nie musi być super szczegółowa).
Szukając na necie znalazłem i wypróbowałem trzy rozwiązania, ale każde ma poważne problemy:
Visual Studio 2013 Ultimate - do tej pory najlepsze z tych trzech podejść. W Architecture Explorer wybrałem Solution View, z niego listę projektów w solucji, które chciałem uwzględnić (wyrzuciłem np. testy jednostkowe i integracyjne, dla nich nie chcę diagramu), następnie w Project Items wybrałem pliki cs z kodem, wreszcie w sekcji Types niektóre typy (pominąłem niepotrzebne). Przeniosłem i upuściłem zaznaczone elementy z okna Types na UMLClassDiagram1.classdiagram i utworzył mi diagram klas.
Niestety, ponieważ solucja jest duża, zawiera sporo projektów i sporo klas, schemat jest bardzo duży, źle sformatowany i nieczytelny. Jakakolwiek manualna zmiana formatowania tego schematu jest bardzo uciążliwa.
Po pierwsze, elementy reprezentujące klasy są ułożone kolumnowo, tzn. max dwie klasy w jednej kolumnie (czyli pionowy pasek przewijania jest niesamowicie długi, a miejsce po prawej marnowane). Po drugie, wszystkie nazwy są poucinane i zamiast NazwaMojejKlasy widzę NazwaM...lasy.
Tam, gdzie jest dużo Literals, Attributes lub Operations, są one rozwinięte, tworząc w rezultacie niesamowicie długie bloki dla pojedynczej klasy. Mogę je schować klikając symbol w lewym górnym rogu schematu klasy lub minusem zwijając listę, ale w takiej sytuacji muszę manualnie przesuwać bloki do góry, aby uniknąć pustego miejsca.
Innymi słowy, edycja tego schematu zajęłąby niesamowicie dużo czasu i była wybitnie niewygodna.
StarUML - tu nie mogłem wybrać solucji, ani nawet projektu, a tylko pojedyncze pliki cs. W takim razie wybrałem te pojedyncze pliki cs, wykonałem Reverse Engineering i niestety, dla każdego pliku otrzymałem Unrecoverable Parse Error.
NClass - tutaj musiałem wybrać plik dll lub exe. W takim razie wybrałem exe będący głównym plikiem mojej aplikacji. Dostałem kilka niezbyt użytecznych diagramów (tylko z exe, nie z powiązanych dll). Co więcej, długiej listy metod nie mogę nawet zwinąć.
W jaki sposób Wy generujecie czytelne diagramy UML do dokumentacji z solucji C#?
Przede wszystkim chciałbym mieć diagram klas, przypadków użycia i diagram sekwencji. Przynajmniej ten pierwszy powinno się dać wygenerować automatycznie.
Pozdrawiam!