Android Studio: Unterscheiden Sie verschiedene Arten von Kommentaren

Question

Ich würde gerne Design-Entscheidungen in den Kommentaren sowie. Ich möchte, dass Design-Entscheidungs-Kommentare von den Kommentaren der Funktions-Contracts bei der oberflächlichen Untersuchung des Quellcodes unterscheidbar sind.

Wie geht es?

Answer 1

Wenn ich die Frage bin zu verstehen, dann ist dies so ziemlich der Standard Anwendungsfall für 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 
    // ... 
} 

Die vertragliche Beschreibung ist in Javadoc, die durch Kommentare in einem Block Kommentar, das ist mit umwickelten definiert ist /** */ (speziell zwei Sternchen am Anfang; die Signatur von Javadoc), und Design-Entscheidungen/allgemeine sind in normalen Kommentaren (// oder weniger häufig /* */).