• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Diagram Explanations

 
Antonio Rafael Rodrigues
Ranch Hand
Posts: 74
1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello. I'm confused about a little thing ...
What is the best option (or the most common) to explain the diagrams?
Comments (by notes) inside the diagram or text bellow it.


 
Jeanne Boyarsky
author & internet detective
Marshal
Posts: 35279
384
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
There isn't one universal best way. It depends how long your comment is. Most of mine were long so I put them as text below the main diagram.
 
Antonio Rafael Rodrigues
Ranch Hand
Posts: 74
1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes. It really makes sense. I have got a lot of big notes now.
I'm having to change almost all the cardinalities that came in the Domain Model, the explanations are getting bigger each minute \o/
Thanks.
 
Antonio Rafael Rodrigues
Ranch Hand
Posts: 74
1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
One more thing.
Do I have to explain every class and relationship in my class diagram?
There is classes that came from the given domain model and I didn't change it, neither their relationships.
Do you make comments to explain the maintained characteristics too?
 
Jeanne Boyarsky
author & internet detective
Marshal
Posts: 35279
384
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
No. I only added comments for assumptions and things that weren't obvious. For example, if a lamp has a light bulb, I don't need to explain that. I can just put it in the class diagram.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic