我在为主方法编写 Javadoc 注释时遇到问题@param

Question

我对Java很陌生，参加在线课程几乎没有反馈。

我想我已经完成了程序，但我的教授需要评论才能完成，我没有指导。 我最大的领域似乎是@param评论。 我试过把不同的东西放在那里，但没有什么是正确的。 谁能告诉我我做错了什么？给我一个链接，以便于阅读有关@param评论的信息。

这是我的代码：

/**
 * 
 */
package edu.westga.cs6311.rectangles;
import java.awt.Rectangle;
/**
 * The RectangleIntersection class creates two rectangles that overlap (making a third rectangle) with a fourth rectangle not overlapping.
 * @author Tanya Fairbanks
 * @version 9/8/2013
 */
public class RectangleIntersection {
    /**
     * The main method is where the rectangles are created.
     * @param   rectangle1  the original rectangle
     * @param   rectangle2  the overlapping rectangle
     * @param   rectangle3  the rectangle made from intersecting rectangle1 & rectangle2
     * @param   rectangle4  the rectangle made that does not intersect with rectangle3
     */
    public static void main(String[] args) {
        // make 2 overlapping rectangles 
        Rectangle rectangle1 = new Rectangle(3, 12, 5, 3);
        Rectangle rectangle2 = new Rectangle(5, 11, 6, 4);
        System.out.println(rectangle1);
        System.out.println(rectangle2);
        //intersection of rectangles 1 & 2 is rectangle3
        Rectangle rectangle3 = rectangle1.intersection(rectangle2);
        System.out.println(rectangle3);

        //figure the area of rectangle3
        double width = rectangle3.getWidth();
        double height = rectangle3.getHeight();
        double area = width * height;
        System.out.println("Expected area: 9.0 ");
        System.out.println("Calculated area: " + area);
        //create 4th rectangle that doesn't overlap 3rd
        Rectangle rectangle4 = new Rectangle(1, 15, 13, 12);
        System.out.println(rectangle4);
        //find intersection of 3rd and 4th rectangles
        Rectangle theIntersection = rectangle3.intersection(rectangle4);
        System.out.println(theIntersection);
        //print expected area and calculated area of theIntersection
        double width2 = theIntersection.getWidth();
        double height2 = theIntersection.getHeight();
        double area2 = width2 * height2;
        System.out.println("Expected area: 0.0");
        System.out.println("Calculated area: " + area2);

    }
}

Answer 1

@param必须匹配所记录方法的参数，例如：

/**
 * A method that adds x and y.
 * @param x The first operand
 * @param y The second operand
 */
public int add(int x, int y) {
    return x+y;
}

在您的情况下，您希望记录程序命令行参数。使用普通的javadocs来做到这一点。