Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

How to use Java Documentation ??

 
Amit Dugar
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi All,

As you can see from my question(How to use Java Documentation ??) , I am a java learner. I really want to know that how i can use the java documentation. Is it really helpful ? If yes, in what sense is it helpful .. Any help will be appreciated

Thanks in advance
 
Balasubramanian Chandrasekaran
Ranch Hand
Posts: 215
Firefox Browser Linux VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Amit Dugar:
Hi All,

As you can see from my question(How to use Java Documentation ??) , I am a java learner. I really want to know that how i can use the java documentation.


You can take a look at this one to get started.


Is it really helpful ? If yes, in what sense is it helpful ..


If you are building your own API then it is really necessary to create Java Document for your custom API. I think as a beginner you don't need to get in depth with it right now.
 
Rodrigo Tomita
Ranch Hand
Posts: 70
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I suppose you are talking about Java API documentation. In the same way you can create API documentation for your own code, as Balasubramanian mentioned, Java API has its own documentation.

This documentation (also known as javadoc) contains information about all the classes made available by a standard JVM and how to use it. So, you don't have to code everything by yourself but rather use these utility and foundation classes.

You can try googling by "javadoc" and find more info about it.
 
Campbell Ritchie
Sheriff
Pie
Posts: 49776
69
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Does that answer your question? Or were you asking something else?

What you get in the API documentation (here) is a list of classes and packages. For each class (or interface or enum) it gives, more-or-less from top to bottom,
  • Class name, and what it inherits from
  • Description of the class
  • List of its constructors
  • List of its fields
  • List of its methods
  • List of methods inherited from superclasses
  • Description of its constructors
  • Description of its fields
  • Description of its methods.
  • You will have to pick a class, any class, maybe this one: HashMap and read through its web page.

    You just have to get used to the format; it does take a little time.
     
    Marilyn de Queiroz
    Sheriff
    Posts: 9066
    12
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Responses also in the duplicate thread (which has been closed)
     
    Amit Dugar
    Greenhorn
    Posts: 13
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Thanks all It really cleared my doubt
     
    akhilesh pandey
    Greenhorn
    Posts: 17
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    Java docs basically helps you to gives details of all the methods present in that class and its hierarchy.Little sample code is also present some times.
     
    Campbell Ritchie
    Sheriff
    Pie
    Posts: 49776
    69
    • Mark post as helpful
    • send pies
    • Quote
    • Report post to moderator
    "Akhi tronics" welcome to JavaRanch.
    I have already querired your displayed name.
     
    • Post Reply
    • Bookmark Topic Watch Topic
    • New Topic