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

I'm very new to Java and taking an online course with little feedback.

I think I have the program completed okay, but my prof requires comments to be done and I've had no guidance on them. My biggest area seems to be the @param comments. I've tried putting different things in there but nothing is correct. Can anyone tell me what I'm doing wrong? Give me a link for easy to read info on @param comments.

Here's my code:

/**

*

*/

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);

}

}

解决方案

@param must match an argument of the method being documented, e.g:

/**

* 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;

}

In your case, you want to document program command-line arguments. Use plain javadocs to do that.