greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

good practice for java doc (#29252) 

good practice for java doc
pull/29942/head^2
Shamp 2019-02-24 01:47:24 +05:30 committed by Manish Giri
parent 132c0260c4
commit 06fe81b587
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
guide/english/java/comments-in-java/index.md
View File

@ -43,7 +43,9 @@ public class MyFirstJava {
#### 3. Documentation Comments
Documentation comments are used by the Javadoc tool to create documentation for the code. Documentation comments are used by developers to document code, such as explaining what a class or method does. These comments are parsed by a Javadoc tool, which will compile a preformatted set of HTML files containing all the information available in the comments. The output typically is HTML files created for your code which are more readable and can be shared as well.
Documentation comments are used by the Javadoc tool to create documentation for the code. Documentation comments are used by developers to document code, such as explaining what a class or method does. These comments are parsed by a Javadoc tool, which will compile a preformatted set of HTML files containing all the information available in the comments. The output typically is HTML files created for your code which are more readable and can be shared as well.
It's always a good practice to write the javadoc before actually writing the function or method block of code. It helps in focusing on the purpose of method/class and creating modular code.
```java
/**