32

注释是如何@param工作的？

如果我有这样的事情：

/* 
*@param testNumber;
*/

int testNumber = 5;
if (testNumber < 6) {
   //Something
}

这将如何@param影响 testNumber？它甚至会影响 testNumber 吗？

谢谢。如果我用错了，请告诉我。

4

5 回答 5

39

@param是javadoc用来生成文档的特殊格式注释。它用于表示方法可以接收的参数（或多个参数）的描述。还有@return和@see分别用来描述返回值和相关信息：

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format

除其他外，还有：

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
于 2013-04-22T01:51:55.610 回答
20

@param不会影响号码。它只是用于制作 javadocs。

有关 javadoc 的更多信息： http ://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

于 2013-04-22T01:45:03.873 回答
4

@param不会影响 testNumber。它是一个Javadoc注释 - 即用于生成文档。您可以Javadoc在类、字段、方法、构造函数或接口（例如 , ）之前立即添加@param注释@return。一般以' @ '开头，必须是第一个就行。

使用的优点@param是：- 通过创建包含属性和一些自定义 Javadoc 标记的简单 Java 类，您可以让这些类作为代码生成的简单元数据描述。

    /* 
       *@param testNumber
       *@return integer
    */
    public int main testNumberIsValid(int testNumber){

       if (testNumber < 6) {
          //Something
        }
     }

每当在您的代码中重用 testNumberIsValid 方法时，IDE 都会向您显示该方法接受的参数和该方法的返回类型。

于 2016-07-10T08:43:35.327 回答
0

它基本上是一个评论。众所周知，从事同一个项目的许多人必须了解代码更改。我们在程序中对参数做一些注释。

于 2017-11-17T17:47:59.587 回答
0

您可能会错过 @author 并且在 @param 内部您需要解释该参数的用途、使用方法等。

于 2020-04-14T17:37:19.153 回答