Androidスタジオ：異なるタイプのコメントを区別する

Question

コメントにもデザインの決定を提供したいと思います。私は、意思決定コメントを機能契約コメントと区別できるようにしたい、ソースコードを簡単に調べることを望む。

どのようにすればいいですか？

Answer 1

私は質問を理解していた場合は、これはかなりのJavadocのための標準的な使用例です：

/** 
* Contractual description of the method. 
* 
* @param bar Describe expectations of parameter bar 
* @return Describe what can be expected of the return 
*/ 
// Some non-contractual comment for the method as a whole. 
public int foo(int bar) { 
    // Some comment for code section a. 
    // a 
    // Some comment for code section b. 
    // b 
    // ... 
} 

契約記述がで包まれたブロックコメントのthatsのコメントによって定義されるのJavadoc、です/** */（開始時に特に2つのアスタリスク、Javadocの署名）、およびデザイン決定/一般は通常のコメント（//、またはあまり一般的ではない/* */）です。