• Post Reply Bookmark Topic Watch Topic
  • New Topic

Comment Location?

 
Chris Bicnal
Ranch Hand
Posts: 99
1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Howdy all,

So I'm in the final stages of packaging up my application and have a question on what folks have done about comments.

I have a ton of comments on my deployment diagram and am wondering whether it's better to leave them on the diagram or move them to index.html with a link to the "clean" diagram from there.

What did folks do?

Chris
 
Jeanne Boyarsky
author & internet detective
Sheriff
Posts: 36031
432
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Chris,
I put the majority of my comments in a bulletted list on the main page. I only put a UML comment in the diagram if it was EXTREMELY context specific.
 
Chris Bicnal
Ranch Hand
Posts: 99
1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks Jeanne - can I assume from your reply that you also included your risk list and assumptions within the index.html document as opposed to linking to separate files?
 
Jeanne Boyarsky
author & internet detective
Sheriff
Posts: 36031
432
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes, I put that on the main page and linked to the diagrams. I wanted to make it more likely that the assumptions and such would get read first.
 
Gravity is a harsh mistress. But this tiny ad is pretty easy to deal with:
the new thread boost feature: great for the advertiser and smooth for the coderanch user
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!