wood burning stoves*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes javadoc reference Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "javadoc reference" Watch "javadoc reference" New topic
Author

javadoc reference

Ronnie Phelps
Ranch Hand

Joined: Mar 12, 2001
Posts: 329
Where can I find a good reference for javadoc standards? And also what's the purpose of the <code></code> tags.
Mark Spritzler
ranger
Sheriff

Joined: Feb 05, 2001
Posts: 17249
    
    6

Here's a link to Sun's Javadoc pages. it has a FAQ and other trails.
JavaDoc main page

As far as the <code> tag, if you are talking about in this forum. It is so that your formatted code is shown in that format. If you just past it in a reply then you probably won't get your nice Tabs in there, and things won't line up and look nice a pretty.
Mark


Perfect World Programming, LLC - Two Laptop Bag - Tube Organizer
How to Ask Questions the Smart Way FAQ
Adam Roberts
Ranch Hand

Joined: Mar 18, 2002
Posts: 71
You can also just look at the data class javadocs, it gives a pretty good idea of what they might want.


Adam Roberts - SCJP2, SCJD<br />insert witty something here
nilesh prasad
Greenhorn

Joined: Apr 30, 2002
Posts: 3
Hi Adam,
I feel quite stupid asking this, but where is the data Javadocs? Was this in the assignment jar file?
Nilesh
Mark Spritzler
ranger
Sheriff

Joined: Feb 05, 2001
Posts: 17249
    
    6

Nilesh
Adam is talking about the comments in the Data.java file. They are the comments above each method. Starting with /** and it has some @ signs to add exceptions, parameters, et al. That is javadoc.
Mark
Colin Froggatt
Greenhorn

Joined: Feb 26, 2002
Posts: 10
Hi Ronnie, get yourself a copy of 'Java in a Nutshell' by O'Reilly. I've found it an invaluable ref for most aspects of the core java API and tools and it's inexpensive (comparatively). check out this link to amazon - Java in a Nutshell - BigC
Vivek Rana
Greenhorn

Joined: Feb 19, 2002
Posts: 11
Just check the source of java in src.jar
for good java doc.
apart from that, i have one question to ask
about User/Server doc, as it is worth 10 marks,
do we need to put screen shots also there ?
what and how much needs to be there ?

Thanks
Rana :roll:
Mark Spritzler
ranger
Sheriff

Joined: Feb 05, 2001
Posts: 17249
    
    6

"Reddi"-
-Rana-
Welcome to the JavaRanch! Please adjust your displayed name to meet the
JavaRanch Naming Policy.
You can change it
here.
Thanks! and welcome to the JavaRanch!

As for the User documentation. You can either create a nice text fiel that describes how to use your app.
Or you can go and create HTML pages of your user docs, add screen shots, and add it to a JScrollPane in a JFrame and make it available from your app. I think this is the coolest, and it isn't that difficult to do. and the surest way to get the entire 10 points.
Just do a search on User Doc on this forum and you should get some that explain how to create them.
Good Luck
Mark
 
Consider Paul's rocket mass heater.
 
subject: javadoc reference
 
Similar Threads
instanceof Operator
JavaDoc <code> or link?
Object Arrays -Initialization
JavaDoc and package index
Display date format by calendar entry