如何向Google端点添加自定义评论

Question

我正在使用Google Eclipse插件创建一个app-engine连接的Android应用程序。在android项目中，我只能看到有关我的端点方法的通用无意义注释。有没有办法让我的自定义评论显示？

（回想一下，在eclipse中，您可以通过将鼠标放在方法名称上来查看方法的Java文档。）

以下是通用评论的示例：

Create a request for the method "register".
This request holds the parameters needed by the Pouton server.  After setting any
optional parameters, call the `Register.execute()` method to invoke the remote operation.

Answer 1

更改端点方法的Javadoc就像更改任何其他方法的Javadoc一样...有关详细信息，请参阅Oracle Javadoc documentation。

基本上你必须使用你的Endpoint的源代码转到.java文件（如果你自动生成了Endpoint，文件名为YourClassEndpoint.java），你只需要去到您想要更改Javadoc的方法，并更改方法上方的注释。

像这样：

/**
 * Here is your generic comment, just delete this text and add your own...
 * It can be as long as you want...
 *
 * @param Here the explanation of the parameter "bar1".
 * @param Here the explanation of the parameter "bar2".
 * @return Here the explanation of the returned value.
 */
public Foo someMethod(Bar bar1, Bar bar2) {
    //...
}

只需在方法的基础上添加这种注释，Eclipse（和其他工具）就会知道这些注释代表Javadoc并且会正确显示它......