• Post Reply Bookmark Topic Watch Topic
  • New Topic

Java Documentation  RSS feed

 
Neil Forrest
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I'm working on an assignment that asks for me to do specific documentation on some methods that I've had to code. It sounds like I have to describe in detail what each of the methods do, but I'm not clear on to what length I should go and if there is any specific format. Does anyone know of some simple examples of java documentation that I might look at to get an idea?
Thanks,
Neil
 
Ernest Friedman-Hill
author and iconoclast
Sheriff
Posts: 24217
38
Chrome Eclipse IDE Mac OS X
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Probably you're being asked to use Javadoc. Here's the tool documentation, and here are the results. You can create the exact same kind of documentation from your own source code just by adding the appropriately formatted comments. As for content -- look at the API docs linked above for many thousands of examples!
 
Jesper de Jong
Java Cowboy
Sheriff
Posts: 16028
87
Android IntelliJ IDE Java Scala Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Here is an article with a lot of hints and tips about writing Javadoc comments:
How to Write Doc Comments for the Javadoc Tool
 
Neil Forrest
Greenhorn
Posts: 13
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks to both of you...great resources!
Neil
 
Layne Lund
Ranch Hand
Posts: 3061
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Ernest Friedman-Hill:
...As for content -- look at the API docs linked above for many thousands of examples!


Just because these are the official Java API docs, don't for a minute assume that they are all GOOD examples. Some sections of the API are better than others.
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!