对@param标签的使用有点困惑

时间:2014-01-12 18:50:04

标签: java parameters

您好我想知道@param标签是做什么的?我读了一些关于各种其他stackoverflow问题和java的文档,但我仍然感到困惑。有人可以用更简单的术语解释它(我是一个初学程序员)吗?根据我的解释,它基本上告诉了方法接受的参数类型是正确与否?谢谢!

1 个答案:

答案 0 :(得分:1)

它用于为您的类生成javadoc的“parameters”部分。但它不会影响代码编译或运行的方式。

例如,这个:

/**
 * Returns the string representation of the {@code Object} argument.
 *
 * @param   obj   an {@code Object}.
 * @return  if the argument is {@code null}, then a string equal to
 *          {@code "null"}; otherwise, the value of
 *          {@code obj.toString()} is returned.
 * @see     java.lang.Object#toString()
 */
public static String valueOf(Object obj) {
    return (obj == null) ? "null" : obj.toString();
}

成为this

  

public static String valueOf(Object obj)

     

返回Object参数的字符串表示形式。

     

参数:       obj - 一个对象。

     

返回:       如果参数是null,则字符串等于“null”;否则,返回obj.toString()的值。

     

参见:       Object.toString()