如何在JavaDoc注释中描述状态转换

Question

我定义了一个状态Enum。我想在Java注释中显示状态之间的转换过程。我该怎么做？你能给我一个评论模板吗？

Answer 1

＆＃34;转换过程＆＃34;意思？ 这是对的吗？

/**
 * Define enum
 */
public enum MyEnum{
            SUCCESS;
}

protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    function();
}

/**
 *This is xxxx function.
 * @return {@link MainActivity.MyEnum#SUCCESS}:Return Success.
 */
public int function(){
    return MyEnum.SUCCESS.ordinal();
}