Writing Javadoc Comments and creating an API with the Javadoc Tool on Eclipse - Java - Appficial



0
8408

Javadoc comments are those that start with a /** and end with a */. They are typically found above every class and method definition. Javadoc is a tool that parses your program for Javadoc comments and generates an Application Programming Interface (API). An API is documentation for your program in HTML format, that looks similar to Oracle’s Java API. You can include block tags (annotations) in your Javadoc comments such as @param to describe a method parameter @return to describe method return type You can run the Javadoc tool on an IDE or on the command line with: javadoc –d destination ProgramName.java

Published by: Appficial Published at: 6 years ago Category: آموزشی