File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
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


Isaac Ferguson
Ranch Hand

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

why in some code I see this

* @param args

When and why it is used?

Joanne Neal

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

Campbell Ritchie

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

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

Joined: Jan 10, 2002
Posts: 63529

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

[Asking smart questions] [About Bear] [Books by Bear]
I agree. Here's the link:
subject: Param
It's not a secret anymore!