注释的写法
C++ 支持单行注释和多行注释。注释中的所有字符会被 C++ 编译器忽略。
单行注释:
//这里填写注释内容
多行注释:
/*
这里填写注释内容
......
*/
注意事项
注释应尽量使代码更易读,如
a=b;//将b赋值给a
这行代码本身明显比注释更加明了 ,添加的注释反而转移人的注意力,增加了阅读量,写这种注释是吃力不讨好的举动。而且这种注释和语句关联性更大,代码一旦更改,注释也要随之更新,我们往往这时会忘记这一步。
c=b;//将b赋值给a
这时,代码阅读者将会困惑到底是代码语句出错了,还是注释出错了。所以这种语句往往不要画蛇添足的添加注释。
a=b;
如果在程序里用意义明确的名字,注释只是偶尔才需要。如果不用意义明确的名字,即使加了注释也不能使代码更好懂一些。
另外,应尽量采用标准库中的组件如
swap(a,a+1);
sort(a,a+max);
copy(a,a+max,ostream_iterator<T>(cout,"\n"));
像swap、sort和copy等这些组件往往不需要对他们进行任何注释。