Question

以这种方式调用活动（例子）：

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期望的参数以及返回的类型。

Answer 1

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

    /**
    * JavaDoc
    */      
    public class MyActivity {

Answer 2

右键单击方法名称 - ＆gt;源 - ＆GT;生成元素注释。

快捷方式

ALT+SHIFT+J

Answer 3

将参数常量声明为public static final String并在那里添加javadoc字段文档。
使用@link将事物绑定在一起。

示例：

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

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

Answer 4

在方法顶部键入/**，然后按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评论Android的活动？

4 个答案: