UML dokumentation

Der er produkter som kan generere UML fra kode.

Visual Paradigm
Enterprise Architect/Sparx

Jeg mener saagar at der er noget basal funktionalitet i VS.

Men jeg er skeptisk overfor ideen.

Formaalet med UML er at give overblik ikke detaljer. Et klasse diagram som viser alt giver ikke overblik.

Derfor er manuelt tegnede klasse diagrammer som kun viser det vaesentlige langt bedre end genererede klasse diagrammer som viser alt (fordi et program ikke kan se hvad der er vaesentligt).

Tak for info.

Enterprise Architect har jeg forsøgt, men det kræver tilsyneladende en mellemlang videregående uddannelse at finde rundt i = jeg kan ikke lure at bruge programmet på 10 minutter. Kan kun genere noget klasse view a la Visual Studio, hvor alle boksene ligger hulter til bulter oven i hinanden.

Hvis UML gør dig skeptisk, har du så et bedre forslag til dokumentation, der kan hjælpe en anden person med at overtage min kode.

Hvad ville du/i gøre i den situation?

Jeg er super glad for UML. Men for haandskrevet UML ikke for genereret UML.

Altsaa: the hard way !!

Mine erfaringer med EA er ioevrigt nogetlunde de samme.

:-)

SUK....

Havde håbet, at alle de Xtreme Programming folk derude, der koder først og tænker undervejs (eller bagefter), havde sørget for, at lave nogle tools, der kunne hjælpe dem med at dokumentere deres arbejde.

Jeg har i mellemtiden gravet dybere ned i Google og tilsyneladende indeholder VS.2010 Beta nogle UML funktioner. Så dem kigger jeg på i aften og hvis det ikke kan smide noget fornuftigt af sig, så.... hmmm.... må jeg jo snakke mig ud af udfordringerne :-)

Smid et svar.

Problemet er ikke saa meget at reverse engineere fra kode til UML - det er ikke svaert.

Men kun at tage det med som er "vigtigt" og vise det saa det ser "godt" ud er meget svaert.

Og et svar.

Hvad er overhovedet ideen i at dokumentere koden på diagram form?

UML er da mere et værktøj til udvikling, end dokumentation!

UML er skam ogsaa et vaerktoej til dokumentation. Fornuftige klasse diagrammer (uden alle detaljer), sekvens diagrammer etc. er glimrende vaerktojer til at give et overblik over hvordan noget kode virker.

Og det er vel ikke specielt overraskende at noget som fortaeller den oprindelige udvikler hvordan koden skal skrives ogsaa er egnet til at give maintenance udviklerne en forstaaelse for hvordan koden fungerer.

Jeg vil kalde det rimeligt standard at UML indgaar i dokumentationen.

Jeg har da brugt de autogenererede diagrammer fra Visual Studio som dokumentation ved flere lejligheder. Jeg synes de er en fantastisk feature.... Man styrer jo selv hvor mange detaljer de skal vise.

Bitmatic:
"Autogenererede diagrammer fra Visual Studio".

Du skriver i flertal? Kan man lave andre spændende diagrammer end Class View i VS.Net?

Windcape:
Hvis du ikke er til UML, hvordan ville du så dokumentere kode, der skal afleveres til nye programmører?

Man kan kun lave den ene slags diagrammer i VS2008, men man kan jo lave ligeså mange af dem man lyster, og med præcis det indhold man lyster :-)

I øvrigt er det lidt forkert at betragte det som et tool til at generere diagrammer. Diagrammerne er en 1:1 afspejling af koden - så det er i ligeså høj grad et tool til at lave kode....

> Hvis du ikke er til UML, hvordan ville du så dokumentere kode, der skal afleveres til nye programmører?

Hvis jeg ikke har brugt diagrammer til at beskrive udviklingen, så burde koden jo netop være strukturet nok til ikke at kræve dokumentation på diagram form.

Derudover har Visual Studio jo god support for diagram display af klasser og relationer. Men jeg ser ikke hvordan det er mere hjælpsom end en god API struktur, som nu engang afhænger af at være designet godt fra starten.

Hvis man skal overskue store kode maengder er det noedvendigt med dokumentation til at give overblik. Ogsaa selvom koden er velstruktureret.

Men UML disgrammer som viser alle de samme detaljer som koden giver ikke nogen hjaelp, fordi saa kan man lige saa godt laese koden. UML diagrammer skal give overblikket.