我说说我们实际工作的时候怎么做吧：
首先，命名要规范，函数名用英语缩写最好，实在不行用拼音缩写也行，只要你自己能看懂，这样看到函数名就大概知道这个函数是干嘛的了。例如 ReadFile，一看就知道是读文件，还要写什么注释呢？
同时变量名要遵从匈牙利命名法。
然后，一般简单的代码都不会有注释和说明的，大家都是出来混的，这么点代码都看不懂，就不用干这行了
接着，如果是比较关键的函数，或者是要提供给别人的接口，或者是复杂的函数，都要详细注释，每句话，甚至每个参数都可以注释
最后，记住一类的函数最好用相似的名称头，简单举例，求周长：
int CirRect(); //矩形周长
int CirCircle(); //圆形周长
int CirTri(); //三角形周长
这样在工程里会比较方便查看
内容全部来源于网络收集，如有侵权，请联系网站删除：QQ：24596024