• Post Reply Bookmark Topic Watch Topic
  • New Topic

Design doc and javadoc generation

 
K. Tsang
Bartender
Posts: 3610
16
Firefox Browser Java Mac OS X
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all, I'm documenting my design choices as I go along. But how technical and detail should the design doc be? Since I can't use HTML or MS Word so technically I can't use/draw UML diagrams. When describing algorithms, can I use code if that's more direct?

For JavaDoc, are private methods / variables included in the output?
 
Roberto Perillo
Bartender
Posts: 2273
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Partner, I don't think you have to detail that much, like, describing algorithms. The sections of my choices.txt file are the same one as the marking criteria (general considerations, documentation, etc), and there I said things like "The 48-hour rule was not implemented, simply because it was not clear if and how I was supposed to implement it".

About the JavaDocs, you just have to include what is part of the API of your classes, so you just have to include public, protected and default members.
 
Happiness is not a goal ... it's a by-product of a life well lived - Eleanor Roosevelt. Tiny ad:
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!