javadoc

代码准备:

 

/**
  * 此方法对传入的动态数组进行操作,添加一个在0-51之间且与当前数组内不重复的随机数.
  * 并且数组在方法中传递进行的操作在外部是可见的.
  * @param sentIdList 已发送的一方的牌
  * @return 生成的新的牌的ID号
  */
   ....略写....
  return temp;
 }

 

How do I create  javadoc?

 

In the Java Perspective (Window -> Open Perspective -> Java) use:
Project -> Generate Javadoc...
or:
File -> Export -> Javadoc

 

How do I run Javadoc?

1. In the Package Explorer window, choose the package or file for which you want to generate documentation.
2. Choose File -> Export... -> Javadoc -> Next>
   1. If the dialog box displays the message The Javadoc command does not exist, then you need to click the Configure... button and locate javadoc.exe. You already have this file--it is probably in YourJavaDirectory/jdk1.5.0/bin/.
3. Select the project, and the destination for the Javadoc files. Normally, you should only generate documentation for public fields and methods.
4. If you have no assert statements, you can click Finish at this point.
5. Click Next >.
6. Click Next > again.
7. Check JRE 1.4 source compatibility (otherwise your assert statements will be treated as errors). [See also How do I get the assert statement to work?]
8. Click Finish.