我倾向于在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