The following are examples of @param
paragraphs, which may be used in documentation comments for method and constructor declarations:
@param file the file to be searched @param pattern the pattern to be matched during the search @param count the number of lines to print for each match
The information in a @param
paragraph should consist of the name of the parameter followed by a short description.
A documentation comment may contain more than one @param
tag. The usual convention is that if any @param
paragraphs are present in a documentation comment, then there should be one @param
paragraph for each parameter of the method or constructor, and the @param
paragraphs should appear in the order in which the parameters are declared.