good example of Javadoc [closed]

StackOverflow https://stackoverflow.com/questions/1079713

  •  21-08-2019
  •  | 
  •  

Question

is there a good example of a source file containing Javadoc?

I can find lots of good examples of Javadoc on the internet, I would just like to find out the particular syntax used to create them, and assume I can pore through the source of some library somewhere but that seems like a lot of work.

Was it helpful?

Solution

How about the JDK source code, but accessed through a 3rd party like docjar? For example, the Collections source.

That way, there's no big download.

OTHER TIPS

The page How to Write Doc Coments for the Javadoc Tool contains a good number of good examples. One section is called Examples of Doc Comments and contains quite a few usages.

Also, the Javadoc FAQ contains some more examples to illustrate the answers.

How about the JDK source code?

I use a small set of documentation patterns:

  • always documenting about thread-safety
  • always documenting immutability
  • javadoc with examples (like Formatter)
  • @Deprecation with WHY and HOW to replace the annotated element

Have a look at Spring framework source, it has excellent javadocs

Download the sources of Lucene and see how they do it. They have good JavaDocs.

If you are using Eclipse, then you can setup your JDK (not JRE) in Installed JREs, and then use Open Type (Ctrl + Shift + T), give something like java.util.Collections

The documentation of Google Guava's EventBus package and classes is a good example of Javadoc. Especially the package documentation with the quick start is well written.

If you install a JDK and choose to install sources too, the src.zip contains the source of ALL the public Java classes. Most of these have pretty good javadoc.

If all your looking for is the syntax, then this may help:

How to Write Doc Comments for the Javadoc Tool

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top