• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Need Help writting Java Doc Comments

 
Michael Hubele
Ranch Hand
Posts: 182
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I have to write some java doc comments but I am not sure what to put for a couple things.

like for the public class I am unsure how to describe it.

like if I have public class PhoneNumber

what should I put there for the java doc comments.
This is what I usually put in it.

/**
* This is used to define a class called PhoneNumber
* @Author Michael Hubele
*/

I am not sure what else I would put in there.

Also I am not sure for the public static void main(String [] args)

I have this
/**
* The program makes a phone number at random.
* @param args - This takes in array of arguments from the user.
*/

I am also not sure what to put in there either and is that correct what I am saying about the param args? Since we need to have that in there and thats all I could think of puting in.

Thats all the questions I have for now.
 
Ernest Friedman-Hill
author and iconoclast
Marshal
Pie
Posts: 24208
35
Chrome Eclipse IDE Mac OS X
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Here is a guide to writing Javadoc comments. There is a lot of information here. The guide includes technical information, but more importantly, it includes style information and content advice. If you read all of this and pay attention, it will answer all your questions.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic