From 06fe81b587781f5b3d12caa597d39ae641d93263 Mon Sep 17 00:00:00 2001 From: Shamp Date: Sun, 24 Feb 2019 01:47:24 +0530 Subject: [PATCH] good practice for java doc (#29252) good practice for java doc --- guide/english/java/comments-in-java/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/guide/english/java/comments-in-java/index.md b/guide/english/java/comments-in-java/index.md index 2dac9abad4c..664fba29fce 100644 --- a/guide/english/java/comments-in-java/index.md +++ b/guide/english/java/comments-in-java/index.md @@ -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 /**