• Post Reply Bookmark Topic Watch Topic
  • New Topic

Documentation Comments (scjd)

 
Zakaria Haque
Ranch Hand
Posts: 60
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi guys, I am little confused about how much javadoc style comment should we use. I have the following statements in my instructions
1. "javadoc style comments must be used for each element of the public interface of each class"
2. "You must provide HTML/Javadoc documentation for all classes, whether supplied, modified, or new"

Does that mean we can spare the non-public api from javadoc commenting?
Thanks.
 
Mark Spritzler
ranger
Sheriff
Posts: 17309
11
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I would javadoc all your methods, even the private ones.
Mark
 
my overalls have superpowers - they repel people who think fashion is important. Tiny ad:
the new thread boost feature brings a LOT of attention to your favorite threads
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!