/[gzz]/manuscripts/UMLLink/umllink.rst
ViewVC logotype

Diff of /manuscripts/UMLLink/umllink.rst

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.19 by tjl, Tue Jan 21 09:26:41 2003 UTC revision 1.20 by tjl, Tue Jan 21 09:32:38 2003 UTC
# Line 25  between the architectural documents and Line 25  between the architectural documents and
25  Previous work  Previous work
26  =============  =============
27    
28    UML
29    ---
30    
31  Rational Rose  Rational Rose
32    
# Line 37  Rational Rose Line 38  Rational Rose
38    reverse engineering diagrams from existing source code    reverse engineering diagrams from existing source code
39   - though, because we are coders, we would prefer UML language   - though, because we are coders, we would prefer UML language
40     over menus and dialogs when creating UML objects     over menus and dialogs when creating UML objects
41     + we need critic for direct manipulation!     + we need a ref. of criticism of direct manipulation!
42     + though, directmanipulation is only relevant solution for     + though, directmanipulation is only relevant solution for
43       replacing already created objects       replacing already created objects
44    
# Line 64  MetaPhor, hypertext in soft. devel? (htt Line 65  MetaPhor, hypertext in soft. devel? (htt
65     + could be used to create domain spesific languages, when generating     + could be used to create domain spesific languages, when generating
66       code can really work       code can really work
67    
68  This page lists a lot of UML tools:  Javadoc
69  http://plg.uwaterloo.ca/~migod/uml.html  -------
   
 Setting of problem  
 ==================  
70    
71  Javadoc, the hypertext documentation tool that comes with  Javadoc, the hypertext documentation tool that comes with
72  Java (trademark of Sun Microsystems, Javadoc is distributed only  Java (trademark of Sun Microsystems, Javadoc is distributed only
73  as part of Java, non-free), is ...  as part of Java, non-free), is ...
74    
75    Setting of problem
76    ==================
77    
78    javadoc
79    
80      - Easy to check methods, hard to get overall picture.      - Easy to check methods, hard to get overall picture.
81    
82      - Because doc is generated from source, the class, method, field      - Because doc is generated from source, the class, method, field
83        names are always up-to-date(!!)        names are always up-to-date(!!)
84    
85  Architectural docs using UML:      - easy to find a given class
86    
87    Architectural docs with UML diagrams:
88    
89        - good overall picture.
90    
91      - little detail,      - little detail,
92    
93      - may be slightly outdated at any particular time.      - may be slightly outdated at any particular time.
94    
     - good overall picture.  
   
95      - Even outdated but well simplified diagram      - Even outdated but well simplified diagram
96        is better than too detailed, automaticly up-to dated and reverse        is better than too detailed, automaticly up-to dated and reverse
97        engineered diagram.        engineered diagram.
98    
99        - distinct from the javadoc, hard to find explanations
100          for a particular class.
101    
102    The two types of documentation are complementary.
103    
104    "Obvious" question: can we increase the overall value by
105    interconnecting the two?
106    
107    
108    
109  Design  Design
110  ======  ======

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.20

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26