注释分析

注释规则

• 编译器在编译过程中会使用空格替换整个注释
• 字符串字面量中的// 和/**/不代表注释符号
• /.../型注释不能被嵌套（在分段排除异常往往被忽略)

一个有趣的问题

请问 y=x/*p是什么意思？
作者本意：把x除以*p的结果赋值给y
编译器：把/*作为一段注释的开始，把/*后面的内容当成注释的内容，直到*/出现为止
因此可以使用 x/ *p 表示，可见空格的重要性

小结

• 注释应该精准易懂，防止二义性，错误的注释有害无益
• 注释是对代码的提示，避免臃肿和喧宾夺主
• 一目了然的代码避免注释
• 不要用缩写来注释代码，这样可能产生误解
• 注释用来阐述原因和意图，而不是描述程序的运行机制

转载于:https://www.cnblogs.com/yanyun888/p/9150448.html