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

Question

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

Answer 1

“变换过程”是什么意思？ 这是正确的吗？

/** 
* 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(); 
}