注释是什么?为什么写注释?
注释是对代码的说明,编译器会忽略注释,也就是说,注释对实际代码没有影响。
注释是给程序员自己,或者其他程序员看的。
好的注释可以帮我们更好的理解代码,但是也不要过度注释,不要写没必要的注释。当然不写注释可能会让后期阅读代码的人抓狂。写注释一定程度上反应了程序作者的素质,建议大家写必要的注释,在未来找工作的时候,写代码时留下必要的注释也会给⾯试官留下更好的印象。
注释的2种形式
C 语言的注释有两种表示方法。
1./**/ 的形式
第⼀种方法是将注释放在 /…/ 之间,内部可以分行。
/* 注释 */
/*
这是⼀⾏注释
*/
这种注释可以插在行内。
int fopen(char* s /* file name */, int mode);
上面示例中, /* file name */ ⽤来对函数参数进行说明,跟在它后面的代码依然会有效执行。这种注释⼀定不能忘记写结束符号 */ ,否则很容易导致错误。
printf("a "); /* 注释⼀
printf("b ");
printf("c "); /* 注释⼆ */
printf("d ");
上面示例的原意是,第⼀行和第三行代码的尾部,有两个注释。
但是,第一行注释忘记写结束符号,导致注释⼀延续到第三行结束。
/**/ 的这个注释也不支持嵌套注释, /* 开始注释后,遇到第⼀个 */ 就认为注释结束了。
/*
printf("a ");
printf("b ");
printf("c "); /* 注释⼆ */
printf("d ");
6 */
2 // 的形式
第二种写法是将注释放在双斜杠 // 后面,从双斜杠到行尾都属于注释。这种注释只能是单行,可以放在行首,也可以放在一行语句的结尾。这是 C99 标准新增的语法。
// 这是⼀⾏注释
int x = 1; // 这也是注释
不管是哪⼀种注释,都不能放在双引号里面。
双引号里面的注释符号,会成为字符串的⼀部分,解释为普通符号,失去注释作用。
printf("// hello /* world */ ");
上面示例中,双引号里面的注释符号,都会被视为普通字符,没有注释作用。
注释会被替换
编译时,注释会被替换成⼀个空格,所以 min/* 这里是注释*/Value 会变成 min Value ,而不是 minValue 。