如何用JavaDoc评论Android的活动？

以这种方式调用活动，例如：

Intent i = new Intent(context, MyActivity.class);
i.putExtra("par1", "value1"); 
i.putExtra("par2", 2);
startActivityForResult(i);

如何使用类似JavaDoc的方法注释MyActivity类

例如，在这种情况下：

/**
* This activity show some data
* @param par1 String value of parameter1
* @param par2 int number of records to show
* @return returnValue boolean true if data is showed, false otherwise
*/

---

了解intent需要哪些参数以及返回的类型。

右键单击方法名->源->生成元素注释

捷径

ALT+SHIFT+J

---

只需在类声明的顶部编写JavaDoc部分

    /**
    * JavaDoc
    */      
    public class MyActivity {

将参数常量声明为公共静态最终字符串，并在其中添加javadoc字段文档

使用@links将事物绑定在一起

例如：

/**
* String containing foo parameter for {@link #XyzzyActivity}
*/
public static final String EXTRA_FOO = "par1";

/**
* XyzzyActivity
*
* Parameters understood: {@link #EXTRA_FOO}, ...
*
* Returns...
*/

在方法顶部键入/**，然后按ENTER键。注释部分将变成如下内容：

/**
 * 
 * @return
 */

您还可以添加

@author – who wrote this code
@version – when was it changed
@param – describe method parameters
@return – describe method return values
@throws – describe exceptions thrown
@see – link to other, related items (e.g. “See also…”)
@since – describe when code was introduced (e.g. API Level)
@deprecated - describe deprecated item and what alternative to use instead

---

是的，这就是我现在使用的方式，我要求提供最佳实践。也许是我这么做的，但您将常量链接到类javadoc的方式很有趣。我认为您的解决方案与Markus__EI解决方案的合并可能是最好的wayparam用于方法而不是类。您的需求只服务于方法而不是类，类没有参数。