• Post Reply Bookmark Topic Watch Topic
  • New Topic

what is/are Javadoc/Javadocs  RSS feed

 
Tracey Gilmen
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I am setting up a Java IDE (to work through a java tutorial) and there are numerous fields in different sections for the location of "Javadoc".

Is there just 1 Javadoc for all of "Java", but different sections of the JRE/JDK/SDK (version/environment) as shown on the index page of [JDK Documentation] or...
... are there separate and district Javadocs: one for JavaSE, another for JavaME, yet another for JaveEE, and etc. etc. etc. (every conceivable implementation or vertical application like cards and etc.)?

Clarification regarding this issue will be greatly appreciated.
Thanks Tracey
 
Junilu Lacar
Sheriff
Posts: 11494
180
Android Debian Eclipse IDE IntelliJ IDE Java Linux Mac Spring Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Tracey,

Welcome to the Ranch!

Visitors are encouraged to SearchFirst (<-- click) then come back with specific questions. These search results give good explanations of What is JavaDoc. There are JavaDocs for the official Java libraries (JSE, JEE, etc.). Authors of other Java libraries, frameworks, components, usually publish their own JavaDocs as well. There is no ONE JavaDocs for all of Java because "all of Java" continues to grow all the time; it's an ever-expanding universe in and of itself

Tip: Our forums software has a neat feature that automatically links a fully qualified standard Java class name to its JavaDocs. For example, I just had to type java.lang.String in the editor and the forum software automatically turned it into a link. Go ahead, try clicking on the text with the dotted underline. You don't even have to post the message to use this feature. Just click on the Preview button when you're editing a message and you can click on the link in the Preview.
 
David Podolski
Greenhorn
Posts: 6
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Also what is really cool about Javadoc is that you can use it in your own code to automatically generate neat documentation. So for example if you write a method like so (pay attention to the format of the comments):



You can use Javadoc and automatically create this cool HTML documentation about your code,


int sample.SampleClass.addNumbers(int i, int j)

Adds two numbers

Parameters:
i the first number
j the second number
Returns:
the sum of the two parameters


Now anyone using your addNumbers method will be able to easily read what your method does without having to read the code.

 
Don't get me started about those stupid light bulbs.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!