Generating Javadocs

1
Generating Javadocs

• How to professionally
• document your Java code

2
Javadocs

• Javadocs are one of the best ideas in Java
• Essential for efficient browsing of the Java
  library
• Expected in professional SW
• Easily added to Eclipse projects

3
Javadocs

• Comment your Java file
• Comment every
• Class, method, parameter return value
• Enclose comments within / / just above
  classes methods
• Use annotation for author at top of file
• _at_author yourName (both names for pairs!)
• Use annotations for parameters returns
• _at_param parameterName description
• _at_return description

4
Javadocs

• Using Eclipse for Javadocs
• Project menu -gt Generate Javadoc
• Alt p, Alt g
• For Javadoc command, browse to the location of
  javadoc.exe select. For default Java 1.5
  install, its at C\Program Files\Java\jdk1.5.0_0
  8\bin
• Select the project you want to Javadoc
• Accept defaults -gt Next button
• Accept defaults -gt Next button
• Javadocs are generated and Eclipse adds a docs
  folder to the project
• Within docs folder, click on index.html to view
  Javadocs

5
Javadocs

• Javadocs in this course
• Add complete Javadocs to all assignments from
  this point forward (beginning with assign 3)