Skip to main content
ICT
Lesson A6 - Libraries and APIs
  
Main   Previous Next
 

G. Javadoc Tool page 9 of 12

  1. The basics of creating your own APIs are pretty simple. When you add comments in your code, you can use the tag /**...*/ before each class, variable, constructor, and method to create block comments. These comments work within your code in essentially the same way as the regular block comment tag /*...*/. However, once we run the Javadoc tool, APIs will be created based on these comments.

  1. The first line of the comment should be a quick description that sums up what it is in front of. This first line will turn into the quick description that we discussed earlier. The rest of your paragraph should consist of a more detailed description of the item.

  2. When you run your javadoc.exe program on your Java class file (as discussed in Handout A6.1, Javadocs), it will create a few .html files in the local directory. If you open up index.html with your Web browser, you will find yourself looking at an API created for your class.

 
Main   Previous Next
Contact
 © ICT 2006, All Rights Reserved.