This week's book giveaway is in the OO, Patterns, UML and Refactoring forum.
We're giving away four copies of Refactoring for Software Design Smells: Managing Technical Debt and have Girish Suryanarayana, Ganesh Samarthyam & Tushar Sharma on-line!
See this thread for details.
The moose likes Java in General and the fly likes Param Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


JavaRanch » Java Forums » Java » Java in General
Bookmark "Param" Watch "Param" New topic
Author

Param

Isaac Ferguson
Ranch Hand

Joined: Jun 22, 2012
Posts: 563
Hi all,

why in some code I see this

/**
* @param args
*/

When and why it is used?

Thanks
Joanne Neal
Rancher

Joined: Aug 05, 2005
Posts: 3742
    
  16
That's known as Javadoc comments


Joanne
Campbell Ritchie
Sheriff

Joined: Oct 13, 2005
Posts: 43900
    
  32
Angus Ferguson wrote: . . . When . . . it is used?

Thanks
Ideally, all the time. The link Joanne provided will probably explain the rest of the question.
Bear Bibeault
Author and ninkuma
Marshal

Joined: Jan 10, 2002
Posts: 63195
    
  69

Of course the example you showed is a really poor use of it. It should have a description of the parameter.


[Asking smart questions] [Bear's FrontMan] [About Bear] [Books by Bear]
 
Have you checked out Aspose?
 
subject: Param
 
It's not a secret anymore!