What is working of javadoc with real life example?

Question

Brief idea

Answer 1

It is a good way to document your code. Describe who wrote the code, when it was written, the meaning of each function parameters and so on.

IDEs like IntelliJ parse the javadoc and provide you code assistance based on it.

It can also be used to generate documentation pages in HTML through a particular tool. I have forgotten the name of this tool as it has been long I worked with Java.

Answer 2

when google is there...

then why asking here??

//

https://www.tutorialspoint.com/java/java_documentation.htm

https://blog.joda.org/2012/11/javadoc-coding-standards.html

https://idratherbewriting.com/java-javadoc-tags/

https://reflectoring.io/howto-format-code-snippets-in-javadoc/

https://docs.oracle.com/javase/9/javadoc/javadoc-command.htm#JSJAV-GUID-EAAAE17F-E540-42A0-B22B-4D2B2FD3E4D2

https://softwareengineering.stackexchange.com/questions/85910/is-it-wrong-not-to-create-javadoc-for-my-code