应该如何记录主要方法的参数

Question

我应该如何记录以下方法的参数？

public static void main (String[] args) throws IOException

我应该使用@param吗？

Answer 1

使用JavaDoc ...

/**
 * Our main method. Some kind of handy description goes here.
 * @param args The command line arguments.
 * @throws java.io.IOException when we can't read a file or something like that.
 **/
public static void main(String[] args) throws IOException {
  ...
}

Here is a document关于JavaDoc评论的工作原理。

Answer 2

使用javadoc，但在数组（包括varargs）的情况下，我更喜欢描述每个元素的含义，例如

/**
 * Copies a file
 * @param args[0] The source file path
 * @param args[1] The target file path
 * @throws IOException if an error occurs
 **/
public static void main(String[] args) throws IOException {
  //
}

虽然这不是＆＃34;正式批准＆＃34; （AFAIK），它更清晰。

如果这是＆＃34;主要＆＃34;记录异常的方法有点无意义，因为没有什么可以捕获它。