3084 次
1 に答える
4
- JavaDoc はJavaDoc (および IDE) 用です。他には何もありません。できるだけ読みやすいように、リストしたものにコードタグを使用してください。
- 他のコード コメントは、コードの理解に役立ちます。これはコードの一部にすぎず、コードと一緒にしか表示されないため、それ以上のマークアップは必要ありません。
例:
/**
* This method returns <code>true</code> when the sun is shining.
*
* @param weather - A <code>package.name.Weather</code> implementation
* representing the weather to be analyzed.
* return <code>true</code> if the sun is shining, else <code>false</code>.
*/
public boolean isSunShining(Weather weather) {
boolean result = false; // boolean variable for the result. Default is false.
// some more code
/*
* Multiline comment w/o markup
*/
return result;
}
于 2013-02-10T23:02:46.170 に答える