代码里面文档注释到底该怎样写
0
最佳答案
0
当然写注释好 注释可以方便别人理解或维护你的项目
收获园豆：5
其他回答(5)
0
其实注释的作用往往是给下一个开发这个项目的人的，你如果一看这代码就知道干啥的，就不用注释了，如果逻辑复杂的话，还是有必要注释的。
0
https://zhuanlan.zhihu.com/p/25492689
0
写注释需要考虑一点，如何与代码的变更保持同步，如果注释内容与代码实现关联过于紧密，往往容易出现这样的问题——改了代码，没改注释。过时的注释还不如不写注释
0
方法名就是最好的注释~
0
BAD:
//return next day's time
public DateTime GetNextDayTime()
{
Thread.Sleep(86400*1000);
return DateTime.Now;
}
//get user's name
public string GetUserName(string userId)
{
....update db....
....get username
}
//check if is true
public bool Check(....)
{
...balabalalba...
return false;
}
GOOD:
class xxxx:IDisposable
{
....
public void Dispose()
{
....clean
GC.SuppressFinalize(this);
}
~xxxx()
{
throw new Exception("WTF");
}
}
