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

Javadocing Local classes

 
Mark O' Sullivan
Ranch Hand
Posts: 160
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
Just wondering does one need to Javadoc local classes(classes within functions) and if so where does this occur, either:
(1) within the function where class is called.
(2) outside function with normal function Javadoc.
Thanks.
 
Naveen Narayanan
Ranch Hand
Posts: 114
Eclipse IDE Java Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mark,
If you are mentioning inner-classes, I have documented it like normal classes,
Just on top of class declaration no-matter where it comes, and private visibility switched-on.
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mark,

I also documented the inner classes (just like it was a normal class) and documented every member (regardless of the access modifier). I generated javadoc with the -package option (shows only package, protected, and public classes and members).

Kind regards,
Roel

 
Jeffry Kristianto Yanuar
Ranch Hand
Posts: 759
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I documented all the things that can be documented including private variables.

Jeffry Kristianto Yanuar SCJP, SCJA, SCJD
 
Roberto Perillo
Bartender
Posts: 2271
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I didn't have a single inner class.
 
Naveen Narayanan
Ranch Hand
Posts: 114
Eclipse IDE Java Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Howdy Roberto,
I always feel you made app by "Keeping It Simple and Perfect"
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Naveen Narayanan wrote:I always feel you made app by "Keeping It Simple and Perfect"

I don't agree that an app without the use of inner classes is simpler and more perfect than an app using this technique (of course don't overdo it and just use them appropriately).

Kind regards,
Roel

 
Naveen Narayanan
Ranch Hand
Posts: 114
Eclipse IDE Java Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Roberto,
Just for inquisitiveness, How did you implemented ActionListener?
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic