documentation comments in java

Question

on Java documentation comments differ from block comments in that the documentation comments generate external documentation on the source code, so I didn't get the type of documentations they generate. Is there anyone who wants to explain this for me please?

Answer 1

Not my answer, but I'm also interested in javadocs, so sharing the below, which I swiped from Stackoverflow discussion re: same question

The page How to Write Doc Coments for the Javadoc Tool contains a good number of good examples.
https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

One section is called Examples of Doc Comments and contains quite a few usages.
https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#examples

Also, the Javadoc FAQ contains some more examples to illustrate the answers.
https://www.oracle.com/technetwork/java/javase/documentation/index-137483.html

Answer 2

Please remove that link from Relevant Tags. The thread has nothing in relation with your question (it's about Python). Rather tag 'JavaDocs', more closely related contextually.

Besides, if you have links to include with a question, you should put the links in the Description section, not in question title nor the Relevant Tags (links don't work in title nor tags).

Follow this tips for future reference, about posting a question 👍

https://www.sololearn.com/Discuss/333866/?ref=app

Answer 3

it generates html
example of output:
https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/String.html

guide to javadoc tool:
https://docs.oracle.com/en/java/javase/13/javadoc/javadoc.html#GUID-7A344353-3BBF-45C4-8B28-15025DDCC643