Win a copy of The Business Blockchain this week in the Cloud forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Another javadoc question

 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi All,
  • Is it necessary to javadoc private inner classes or methods?
  • Should public members of private inner classes be javadocked?
  • Is it necessary to javadoc private static constants?

  • Thanks in advance,
    Michael Morris
    [ April 24, 2002: Message edited by: Michael Morris ]
     
    Andre Mermegas
    Ranch Hand
    Posts: 158
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    I would say anything that is private visibility does not need to be javadoc'd, but it won't hurt to just give a full javadoc of everything i guess.
     
    Mark Spritzler
    ranger
    Sheriff
    Posts: 17278
    6
    IntelliJ IDE Mac Spring
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    When I did my Javadoc, I used the Java API Documentation as an example.
    If I saw that they documented private or protected variables, then I did too.
    Now, that doesn't mean that you have to do that, and that they will grade you lower. That I do not know.
    Mark
     
    Andre Mermegas
    Ranch Hand
    Posts: 158
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Well basicly the way i look at it is javadoc is really for API publication of your code for reuse right?
    Well anything that is below package visibility is not availible as API so why publish it?
     
    • Post Reply
    • Bookmark Topic Watch Topic
    • New Topic