108 |
UML |
UML |
109 |
--- |
--- |
110 |
|
|
111 |
|
- diagrams are from human to human |
112 |
|
|
113 |
|
+ we don't wan to generate diagrams from the code or generate |
114 |
|
code from the diagrams |
115 |
|
+ generated diagrams are too detailed to be beneficial |
116 |
|
+ basic architectural diagrams should be done before code anyway |
117 |
|
|
118 |
Rational Rose |
Rational Rose |
119 |
|
|
120 |
- quite comprehensive UML design tool for different diagrams (class, |
- quite comprehensive UML design tool for different diagrams (class, |
181 |
and are written either before coding (for design) or after (for exposition |
and are written either before coding (for design) or after (for exposition |
182 |
of the architecture). |
of the architecture). |
183 |
|
|
|
- diagrams are from human to human |
|
|
|
|
|
+ we don't wan to generate diagrams from the code or generate |
|
|
code from the diagrams |
|
|
+ generated diagrams are too detailed to be beneficial |
|
|
+ basic architectural diagrams should be done before code anyway |
|
|
|
|
|
+ and if design documentation is outdated some particular classes |
|
|
maybe don't even exist anymore! |
|
|
|
|
184 |
|
|
185 |
- Include PEGs: possibly not-yet accepted or not-yet implemented proposals |
- Include PEGs: possibly not-yet accepted or not-yet implemented proposals |
186 |
for architectural changes. |
for architectural changes. |
190 |
- fully generated documentation from javadoc comments |
- fully generated documentation from javadoc comments |
191 |
of each class and method in the java source code |
of each class and method in the java source code |
192 |
|
|
|
+ the javadoc output filestructure follows the |
|
|
hierarchical tree structure of java packages and classes |
|
|
|
|
193 |
|
|
|
|
|
194 |
|
|
195 |
|
|
196 |
|
|
236 |
|
|
237 |
|
|
238 |
"Obvious" question: can we increase the overall value by |
"Obvious" question: can we increase the overall value by |
239 |
interconnecting the two? |
interconnecting the two? |
240 |
|
When looking at a design document, jumping to the javadocs |
241 |
|
to get the details would be useful, and |
242 |
|
when looking at a Javadoc, it would be useful |
243 |
|
to be able to see if any design documents refer to that class. |
244 |
|
This is the starting point for the toolchain developed in this article. |
245 |
|
|
246 |
Design |
Design |
247 |
====== |
====== |