Java - 为什么我无法在netbeans上单击生成javadoc按钮？

Question

我试图通过右键单击左侧导航器上的项目为我创建的项目生成一个javadoc。我看到了这个选项，但它不会让我点击按钮＆＃34; Generate Javadoc＆＃34;在净豆。

有人可以告诉我导致这个问题的原因以及如何解决这个问题？

Answer 1

Generate JavaDoc按钮实际上并不生成任何JavaDoc。你需要自己编写文档。

但是，如果您的代码中包含所有文档，则可以单击该按钮，它将生成一个格式良好的HTML页面列表并将它们放入目标（dist）目录

这是为方法提供完整JavaDoc所需的：

 /** 
 * This is a JavaDoc example for an example Method
 *
 * @param someParameter here an explanation what this parameter stands for
 * @return the String value of the parameter
 */
 public String exampleMethod(int someParameter){
      // just a useless example
      return ""+someParameter;
 }

方法签名中的每个参数都需要@param <name of the parameter>，如果方法返回需要@return标记的内容。即使每个人都看到这种方法返回的类型，最好再用短句再提一次。

如果你有，你将不再收到任何警告。也许（当没有更多警告时）NetBeans将允许您使用该按钮生成html页面。