Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

nx: urlybird 1.3.1 javadoc on private methods & classes

 
james render
Ranch Hand
Posts: 72
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You guys who got a perfect score on the javadoc element...
what did you do about private methods and classes,
the requirements do only mention having to javadoc the public interface.
did you do
a) nothing on private ones
b) cut down javadoc maybe missing some tags that you
would have put on the public interface e.g. @return
c) full javadoc
I'm inclined to do b.
thanks again..
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi James,
I wrote the full set of comments for all classes, methods, and variables regardless of what their access was.
However I only ran javadoc with the standard options, so the private methods did not appear in the generated documentation.
Some other thoughts on JavaDoc:
  • @serial tag in Javadoc
  • Should be add doc comments to private members?
  • Explain Javadoc Usuage!
    All three of these links were found by entering the search phrase "javadoc" into the JavaRanch search page, specifying this forum, and specifying only the last 30 days should be searched.
    Regards, Andrew
    [ July 04, 2003: Message edited by: Andrew Monkhouse ]
    [ July 04, 2003: Message edited by: Andrew Monkhouse ]
  •  
    james render
    Ranch Hand
    Posts: 72
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    thanks Andrew,
    sorry should have done search myself - thanks for replying.
     
    • Post Reply
    • Bookmark Topic Watch Topic
    • New Topic