对于java doc注释，如何正确评论void方法？

Question

我知道有参数和构造函数的方法，你做@param或@return但是如何在java docs中引用void方法？

Answer 1

如果方法是自我描述的，我会避免做类似下面的事情：

/** Does Foo */
 void doFoo();

您可以考虑确保方法名称也被考虑在内，例如：

 /**
 * This method currently launches the ball into the air.
 */
void execute() { ... }

到

void launchBallIntoAir() { ... }

请注意，当前的单词也会被使用，因为您的方法可能会随着时间的推移而发展。这看起来有点明显，但如果我是迂腐的话，这就是我会做的事情。