[Even beginners can do it! ] How to write Javadoc
1. Prior knowledge
-[Latest] How to build Java environment on Ubuntu
Or
-[Even beginners can do it! ] How to create a Java environment on Windows 10 (JDK14.0.1)
As prior knowledge, the contents of the above link are required.
2. What is Javadoc?
-- Javadoc is computer software developed by Sun Microsystems, which generates HTML API specifications from Java source code.
--Javadoc comments are comments between/ **and* /.
3. How to write Javadoc and create documentation
Sample.java
/**
* @author author name
* @version x.x.x
*/
/**
*Javadoc commentary main class
*/
public class Sample {
/**
*main method
* @param args not used
*/
public static void main(String[] args) {
//Display of character string
System.out.println("JavaDoc sample");
}
}
--Copy the above statement, specify S-JIS as the character code, save the file name as Sample.java, and execute javadoc -d html Sample.java at the command prompt. ↓ ↓
$ javadoc -d html Sample.java
--The result is as follows.
--Confirm that the html folder has been created.
--Open ʻindex.htmlin thehtml` folder.
--The browser will start and you will see Sample.html.
--If it looks like the image, it is successful.
4. Related
-[Latest] How to build Java environment on Ubuntu -[Even beginners can do it! ] How to create a Java environment on Windows 10 (JDK14.0.1) -[Even beginners can do it! ] How to install Eclipse on Windows 10 (Java environment construction)
Recommended Posts