+ 1

What is documentation comment?

please explain in easy lang

4th Jul 2017, 6:22 PM
Tanya Srivastava
Tanya Srivastava - avatar
3 Respuestas
+ 1
/*Its when you want to put a comment inside your code explaining what its doing like this*/ String x = "your comment wont affect this"; System.out.println(x); // for single lines /* for two line*/ /* just copy and paste this whole message into your play ground to understand better*/
4th Jul 2017, 6:28 PM
D_Stark
D_Stark - avatar
+ 1
the tool javadoc looks for /** * @args int a, SomeClass b * @return SomeOtherClass c * a brief description of what the function does */ and generates the documentation that you would see on IDE pop up or Oracle websites for documentation.
4th Jul 2017, 7:28 PM
Venkatesh Pitta
Venkatesh Pitta - avatar
0
When you see some java output at console, sometimes you find it written in grey color. That text is actually the one inside the documentation comments /**.....*/. The text within these comments actually get printed on the console to make the documentation user friendly.
7th Jul 2017, 5:54 AM
Reeya Patel
Reeya Patel - avatar