strchr函数用法_c++ strchr函数_strchr函数原型(22)

bool success = CalculateSomething(interesting_value,
                                  10,
                                  false,
                                  NULL);  // What are these arguments??

和

bool success = CalculateSomething(interesting_value,
                                  10,     // Default base value.
                                  false,  // Not the first time we're calling this.
                                  NULL);  // No callback.

或使用常量或描述性变量:

const int kDefaultBaseValue = 10;
const bool kFirstTimeCalling = false;
Callback *null_callback = NULL;
bool success = CalculateSomething(interesting_value,
                                  kDefaultBaseValue,
                                  kFirstTimeCalling,
                                  null_callback);

不允许:注意永远不要用自然语言翻译代码作为注释.要假设读代码的人C++水平比你高,即便他/她可能不知道你的用意:

warning:

// 现在, 检查 b 数组并确保 i 是否存在,
// 下一个元素是 i+1.
...        // 天哪. 令人崩溃的注释.

标点，拼写和语法：注意标点,拼写和语法;写的好的注释比差的要易读的多.

注释的通常写法是包含正确大小写和结尾句号的完整语句.短一点的注释(如代码行尾注释)可以随意点,依然要注意风格的一致性.完整的语句可读性更好,也可以说明该注释是完整的,而不是一些不成熟的想法.

虽然被别人指出该用分号时却用了逗号多少有些尴尬,但清晰易读的代码还是很重要的.正确的标点,拼写和语法对此会有所帮助.

TODO注释：对那些临时的,短期的解决方案,或已经够好但仍不完美的代码使用TODO注释.

TODO注释要使用全大写的字符串TODO,在随后的圆括号里写上你的大名,邮件地址,或其它身份标识.冒号是可选的.主要目的是让添加注释的人(也是可以请求提供更多细节的人)可根据规范的TODO格式进行查找.添加TODO注释并不意味着你要自己来修正.

// TODO(kl@gmail.com): Use a "*" here for concatenation operator.
// TODO(Zeke) change this to use relations.

如果加TODO是为了在“将来某一天做某事”,可以附上一个非常明确的时间“Fix by November 2005”),或者一个明确的事项(“Remove this code when all clients can handle XML responses.”).

本文来自电脑杂谈，转载请注明本文网址：
https://www.pc-fly.com/a/jisuanjixue/article-35033-22.html