Search code examples
javadoc

What is the Javadoc?


In past paper questions, it states to define a bunch of terms in the context of Java. The term 'Javadoc' is included in the list. I went through every lecture and the term never came up and most info online is quite technical.

What, in the most easily digestable terms, is the Javadoc?

My current (and likely incorrect) understanding of the Javadoc:

the predefined classes etc used in the Java Development Environment, in HTML format (ie published online - the online part especially sounds incorrect to me)

I used the following sources to try find the definition, but it still isn't entirely clear to me. http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html https://en.wikipedia.org/wiki/Javadoc


Solution

  • It's just a tool that comes with the JDK and used to generate documentation for java code files in HTML format.