You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

PlantUML er et Eclipse-tillegg som støtter visning av UML-diagrammer i et eget panel. Installer tillegget fra følgende oppdateringsadresse: http://basar.idi.ntnu.no/svn/tdt4100/anonymous/trunk/updatesite

Diagrammer brukes mye for å illustrere struktur og oppførsel til objektorienterte programmer og UML har flere diagramtyper som er nyttige, bl.a. objektdiagrammer, klassediagrammer og sekvensdiagrammer. Noen ganger brukes diagrammer for å beskrive ønsket oppførsel til koden i forkant, mens det andre ganger dokumenterer koden. I begge tilfeller kan det være greit å kunne knytte diagrammer til koden og se diagrammene ved siden av koden. Det er dette PlantUML-tillegget til Eclipse tilbyr, et eget PlantUML-panel for visning av UML-diagrammer knyttet til koden en jobber med. Det er forøvrig PlantUML som brukes for å lage UML-diagrammer i denne wiki'n, vha. av et PlantUML-tillegg til wiki-plattformen.

PlantUML utvider Eclipse med to panelet (eng: views), et for visning av diagrammer og et for visning av PlantUML-koden som ligger til grunn for diagrammene. Diagrammene er enten klassediagram utledet fra Java-koden eller ulike UML-diagrammer basert på PlantUML-kode i Java-kommentar-blokker.

PlantUML-panelet

Panelet kalt PlantUML åpnes ved å velge Window->Show View->Other... og så velge PlantUML i PlantUML-kategorien. (Det enkleste er å skrive inn "plantuml" i filter-feltet.). Panelet følger med på hvilken Java-kodefil som er aktiv og viser diagrammet for denne fila.

For en vanlig Java-fil vil PlantUML automatisk generere et klassediagram felt og metoder tilsvarende klassedeklarasjonen i fila. Diagrammet vil bli oppdatert kontinuerlig mens du koder, på samme måte som Outline-panelet. Under ser vi en Java-fil ved siden av det automatisk genererte klassediagrammet i PlantUML-panelet.

Dersom en ønsker å tilpasse det tilsvarende klassediagrammet for en fil, f.eks. legge til klasser eller fjerne private felt og metoder, eller tegne andre diagramtyper, så må en skrive PlantUML-kode for hånd og legge denne koden inn i en kommentar-blokk i fila. Syntaksen er relativt enkel å skrive og lære seg, og PlantUML-nettstedet inneholder mange eksempler på de ulike diagramtypene. Under ser vi denne varianten, hvor PlantUML-kode for et klassediagram uten felt og synlighetsmodifikatorer er skrevet inn i en kommentarblokk.

Det er forøvrig mulig å ha diagrammer i flere kommentarblokker. PlantUML-panelet vil da vise diagrammet i kommentarblokken som er ved der markøren står.

PlantUML Source-panelet

Panelet kalt PlantUML Source fungerer akkurat som PlantUML-panelet, bortsett fra at PlantUML-koden som ligger til grunn for panelet vises istedenfor det tilsvarende diagrammet. Så hvis diagrammet er automatisk generert fra koden, så vises PlantUML-koden for dette diagrammet. Dersom diagrammet er laget fra PlantUML-kode i en kommentarblokk, så er det denne PlantUML-koden som vises.

Nytten av dette PlantUML Source-panelet er først og fremst at det hjelper en å lære syntaksen for klassediagrammer og en får PlantUML-kode å ta utgangspunkt i dersom en ønsker å tilpasse det automatisk genererte diagrammet.

 

  • No labels