activity 的 Javadoc 附加功能 accepted/required

Question

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

如何在 Javadoc 中对此进行记录？

Answer 1

一种方法是在您的 Activity 中定义 public static 方法以获取额外的参数和 return 您将要使用的 Intent开始你的 Activity.

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

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 ==> 键入 /** 在方法签名上方并按回车键

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){

}

activity 的 Javadoc 附加功能 accepted/required

Javadoc extras accepted/required by activity

android

javadoc