aspose file tools*
The moose likes Beginning Java and the fly likes How to use Java Documentation ?? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "How to use Java Documentation ??" Watch "How to use Java Documentation ??" New topic
Author

How to use Java Documentation ??

Amit Dugar
Greenhorn

Joined: Jun 03, 2008
Posts: 13
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

Joined: Nov 28, 2007
Posts: 215

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

Joined: Apr 28, 2008
Posts: 70
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

Joined: Oct 13, 2005
Posts: 36514
    
  16
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

    Joined: Jul 22, 2000
    Posts: 9043
        
      10
    Responses also in the duplicate thread (which has been closed)


    JavaBeginnersFaq
    "Yesterday is history, tomorrow is a mystery, and today is a gift; that's why they call it the present." Eleanor Roosevelt
    Amit Dugar
    Greenhorn

    Joined: Jun 03, 2008
    Posts: 13
    Thanks all It really cleared my doubt
    akhilesh pandey
    Greenhorn

    Joined: Jun 03, 2008
    Posts: 17
    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

    Joined: Oct 13, 2005
    Posts: 36514
        
      16
    "Akhi tronics" welcome to JavaRanch.
    I have already querired your displayed name.
     
    I agree. Here's the link: http://aspose.com/file-tools
     
    subject: How to use Java Documentation ??
     
    Similar Threads
    How to use Java Documentation ??
    Use of package statement
    Handling events in Javascript
    what is meant by jagged array
    ExceptionWrapping