29 |
industry-standard language for specifying, visualizing, constructing, |
industry-standard language for specifying, visualizing, constructing, |
30 |
and documenting the products in software engineering. Recently, various |
and documenting the products in software engineering. Recently, various |
31 |
approaches have been developed towards unifying software architecture |
approaches have been developed towards unifying software architecture |
32 |
design and code. This is done by generating the source code from the UML-based |
design and program source code. This is done by generating the source code |
33 |
architectural model [#]_ or the reverse-engeneering documentation from |
from the UML-based |
34 |
the code [#]_. Nowadays UML seem to be taken in CASE tools even almost |
architectural model [#]_ or by reverse-engineering the documentation from |
35 |
as a visual language, though it's not primarly designed to be a |
the code [#]_. Nowadays UML seems to be taken in CASE tools even almost |
36 |
|
as a visual programming language, though it's not primarly designed to be a |
37 |
programming language [#]_. |
programming language [#]_. |
38 |
|
|
39 |
.. [#] ``XXX`` booch-jacobson-rumbaugh-uml-user-guide? |
.. [#] ``XXX`` booch-jacobson-rumbaugh-uml-user-guide? |
45 |
.. [#] booch-jacobson-rumbaugh-uml-user-guide p.15 |
.. [#] booch-jacobson-rumbaugh-uml-user-guide p.15 |
46 |
booch-jacobson-rumbaugh-uml-reference-manual p.4 |
booch-jacobson-rumbaugh-uml-reference-manual p.4 |
47 |
|
|
48 |
Against the trend of unifying the architectural documentation and code |
Against this trend of using UML to fully unify the architectural documentation |
49 |
fully using UML, we tend still to define the details in the source code and |
and code, we tend still to define the details in the source code and |
50 |
use UML only for planning and document our software architecture in more |
use UML only to plan and document our software architecture on more |
51 |
general level. We keep UML as a common language for intercommunication |
general level. We keep UML as a common language for intercommunication |
52 |
within our software developer team and within project's all stakeholders. |
within our software development team and within project's all stakeholders. |
53 |
In this purpose we prefer more well abstracted and comprehensible |
In this purpose we prefer better abstracted and more comprehensible |
54 |
human drawn diagrams than exact spesifications matching source code to |
human-drawn diagrams to exact spesifications matching source code to |
55 |
every detail: |
every detail: |
56 |
|
|
57 |
"You draw diagrams to visualize a system from different |
"You draw diagrams to visualize a system from different |
65 |
|
|
66 |
.. [#] booch-jacobson-rumbaugh-uml-user-guide, p.24 |
.. [#] booch-jacobson-rumbaugh-uml-user-guide, p.24 |
67 |
|
|
68 |
Altough, even if the architectural documentation won't fully match with |
Altough, even if the architectural documentation won't fully match the |
69 |
details of current implementation, we feel important to enable fast |
details of current implementation, we feel important to enable fast |
70 |
transitions between them. In this article, we present the tools we |
transition between them. In this article, we present the tools we |
71 |
developed for using UML diagrams as multiple-ended hyperlinks between the |
developed for using UML diagrams as multiple-ended hyperlinks between the |
72 |
architectural documents and javadoc generated java source documentation. |
architectural documents and the documentation generated from source code by |
73 |
|
Javadoc. |
74 |
|
|
75 |
Background |
Background |
76 |
========== |
========== |