• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

What is a "javadoc utility" and good documentation?

 
Greenhorn
Posts: 3
  • Likes 1
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
if your told to "include documentation readable by the javadoc utility suitable to the program's size" what is a "javadoc utility?.Would it be like Eclipse or whatever is "containing" Java?.Also could anyone give me an example of a Java program with excellent documentation please?.
 
Java Cowboy
Posts: 16084
88
Android Scala IntelliJ IDE Spring Java
  • Likes 1
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Javadoc is a tool that comes with the JDK, which you can use to generate documentation which looks like the standard Java API documentation.

It works like this: you put specially formatted comments above your classes, methods, interfaces etc., then run the Javadoc tool on your source code, and it then produces a directory containing HTML files.

See the documentation about Javadoc.

Javadoc comments start with /** and end with */. Here's a simple example:

 
Marshal
Posts: 79153
377
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Also, you might find this thread helpful.
 
Greenhorn
Posts: 19
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
It's a really cool to use I've just started to understand it better, its definatly worth reading more about creating classes & methods yourself first so its easier to understand the classes that come with the SDK and you can be well away creating GUI's - if you wanted

My advice from starting out is Javas own tutorial was tricky to understand at first but I didnt know where to look compared to your step-by-step over advertised tutorial websites

After I found the right place on Javas own site things started becoming more clearer and in depth

http://docs.oracle.com/javase/tutorial/java/index.html
 
Campbell Ritchie
Marshal
Posts: 79153
377
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
The Java tutorial has a few things in I don’t agree with, but it is by far the most comprehensive teaching resource I have ever seen for Java. I think in some places it might go too fast for beginners.
 
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
reply
    Bookmark Topic Watch Topic
  • New Topic