我傾向於在1種方法中寫出相當多的評論。偶爾,我指的是另一個類中的另一種方法或屬性。它類似於: //如果取消註釋下一行,請確保檢查'MyClass.SomeMethod'。 [更新] 在試圖希望得到較少的代碼臭評論。也許它可能會像(謝謝@韋斯頓): /// <summary>
/// Adds two numbers
/// See method Subtract for the opposit
我有關於編寫標準javadoc評論的問題。 他們要求我們儘可能具體,並使用謂詞來描述代碼,但是如果我的評論中寫有一個變量「d」,但未在我的代碼中指明,是否會造成問題? 再一次,我問這個問題,因爲我感到困惑,我的老師嚴格評論代碼。 /**
* Find the great common divisor between a 2 number.
*
* @param a number1
* @p