Qual è il modo più comune per incorporare UML nel codice Java?
Sto cercando di aggiungere sequenze UML e diagrammi di classe al mio codice Java, al fine di spiegare i suoi interni e concetti di progettazione. Vorrei che questi diagrammi fossero specificati nei blocchi JavaDoc e poi convertiti in immagini PNG / GIF allegate all'API HTML.
Quale strumento posso usare per l'automazione di questo processo (sto usando Maven 3)?
2 answers
Diagrammi UML all'interno di Javadocs: Questo articolo mostra quanto sia facile e semplice includere diagrammi UML all'interno del tuo Javadoc e anche tenerli aggiornati con ogni modifica nel repository del codice sorgente.
Penso che il modello dovrebbe essere aggiornato e non solo i diagrammi convertiti in PNG/GIF ecc.... Produrre diagramma automatico non ha valore reale. Qual è l'interesse di mostrare ad esempio una classe enorme e tutti i suoi metodi (ad esempio a volte oltre 100) in un singolo diagramma generato automaticamente ? Potresti ottenere un diagramma enorme e non capire perché questo codice è stato scritto e non è riuscito a capire l'architettura, ecc...Vedi solo una vista grafica del tuo codice che non è l'obiettivo di UML !!
Quello che faccio nei miei progetti per il mio codice è usare le seguenti funzionalità:
-
Mostra nascondi javadoc visualizza java doc nel mio diagramma di classe UML
Uso anche il contrario di un metodo per ottenere un diagramma di sequenza.
Quello che apprezzo di più è essere in grado di vivere la navigazione nel codice e quindi estrarre il mio modello e navigare solo nel modello. Posso modellare quello che voglio e provare nuove architetture prima di darlo allo sviluppatore team.
Penso che la generazione automatica del diagramma da includere nel JavaDoc non sia ciò che dovrebbe essere fatto. Se si spendono solo 5 minuti manualmente, si sarebbe in grado di aggiornare il modello esistente con tutte le modifiche. Si sarebbe in grado di creare viste UML personalizzate in cui si sarebbe in grado di aggiungere commenti. Avere viste fornirà informazioni migliori al team risparmiando tempo e aggiungendo qualità al codice.
Quello che puoi fare è fornire un visualizzatore UML per ogni sviluppatore e un link nel tuo JavaDoc. Lo sviluppatore avrà solo bisogno di cliccare sul link e sarebbe in grado di aprire il diagramma che sarebbe aggiornare automaticamente. Nessuna esportazione di immagini più dolorosa, aggiornamento errato perché una volta creata l'immagine è impossibile cambiarla. È ancora possibile creare nuove immagini, ma perdi i tuoi commenti, presentazione ecc..... e ottieni solo un diagramma enorme statico che include tutti i metodi,gli attributi ecc...non essere in grado di rilevare l'associazione avanzata e dipendenza. Solo il rilevamento delle ereditarietà è corretto !!
Il modello UML potrebbe essere utilizzato con maven e SVN e portare davvero valore reale al progetto e alla modellazione che non possono essere raggiunti con l'esportazione di immagini. Mi sembra che tu provi a usare i diagrammi UML solo per aggiungere UML al tuo progetto ma aggiungendo l'esportazione di immagini di un progetto mal invertito senza viste, commenti etc...is non UML e non ha valore in un progetto Java