Question

在我的代码中，我有一些活动需要一些额外的参数（在Bundle中作为Intent传递）才能正常工作。其他一些不需要，或者有一些可选的附加功能。

如何在Javadoc中记录它？

Answer 1

执行此操作的一种方法是在public static中定义Activity方法以获取额外参数并返回您将用于启动活动的Intent。< / p>

假设您有一个名为MainActivity的Activity，它需要一个整数id和一个String名称。这是执行此操作的代码。

public class MainActivity extends Activity {
    private static final String BUNDLE_KEY_ID = "id";
    private static final String BUNDLE_KEY_NAME = "name";

    /**
    * Write your documentation here
    * @param context Required to create new intent
    * @param id write description
    * @param name write description
    */
    public static Intent getIntent(Context context, int id, String name) {
        Intent intent = new Intent(context, MainActivity.class);
        intent.putExtra(BUNDLE_KEY_ID, id);
        intent.putExtra(BUNDLE_KEY_NAME, name);
        return intent;
    }
}

Answer 2

在Android Studio中==＆gt;方法签名＆amp;上方的类型 /** 按Enter键

Studio将为该特定方法创建文档基础知识。

/**
* 
* @param args1
* @param args2
*/
private void doSomething(int args1,float args2){

}

您只需要添加说明。

/**
*  Do something will Blahhh ..Blahhh..
* @param args1 Input argument used to do Blahhh ..Blahhh..
* @param args2 Input argument used to do Blahhh ..Blahhh..
*/
private void doSomething(int args1,float args2){

}

活动接受/要求Javadoc附加功能

2 个答案: