如何写好的注释

1.解释你想做什么(what)，和为什么做(why)，而不是怎么做的(how)

int a = 0;
//把a一直加到10
for (int i = 0; i < 10 ; ++i){
    ++a;
}

比如上面这个代码(。。。其实太简单了，像这种情况你不写注释别人也看得懂)。
解释你想做什么，那么你可能会写出 把a加1一直加到10 类似这样的注释
为什么做，那么你可能会写出 把a加到10方便我们之后做别的运算 类似这样的注释
怎么做，那么你就会写出 用for循环给a加1一直加到10 类似这样的注释

最后这一个你可以很明显看出来是一个错误的示范，很多时候注释并不需要告诉别人你是怎么做到这个事情的，你只需要说明你想做什么或者你为什么想做就可以了。

PS：可以自行换成一段更复杂一点的代码，解释what和why与解释how对比一下。

2.警示

//不要修改下列代码，修改之后不确定能不能正常运行

类型这样

3.阐释某些函数和参数的含义

这一点，如果你函数和参数的命名足够好的话，可以忽略