CppCoreGuidelines NL.3 注释清晰
20 January 2024
“Keep comments crisp”
理由
太细致的注释理解起来很慢,代码里太多的注释使得代码很难解读。
注意
用可理解的英语。我可能德语流利,但是大部分程序员不是。维护我的代码的人可能不会。避免短信用语,检查你的语法、标点、大小写。争取做到专业,而不是酷。
“Keep comments crisp”
理由
太细致的注释理解起来很慢,代码里太多的注释使得代码很难解读。
注意
用可理解的英语。我可能德语流利,但是大部分程序员不是。维护我的代码的人可能不会。避免短信用语,检查你的语法、标点、大小写。争取做到专业,而不是酷。