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

Question

我正在使用 Google Eclipse 插件来创建一个应用引擎连接的 android 应用。在 android 项目中，我只能看到关于我的端点方法的通用无意义 cmets。有没有办法让我的自定义 cmets 显示？

（回想一下，在 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

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

基本上你必须去.java文件和你的端点的源代码（如果你自动生成端点，文件将有名称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（和其他工具）就会知道这些 cmets 代表 Javadoc，并将正确显示它...