第一,假如代码清晰,并且使用了规范的类型名称和变量名称,应该从代码本身就可以理解。第二,编译器不能检查注释,因此不能保证准确,特别是代码修改过以后。误导性的注释会非常令人困惑。第三,排版问题:注释会使代码变得杂乱。 但有时我会写注释,像下文一样仅仅只是把它们用于介绍。例如:解释全局变量的使用和类型(我总...
通常,好的注释应该解释为什么存在某些代码,而不应该解释某些代码在做什么。如果代码不够清晰,无法解释自身,则应使简化代码。也有一些例外情况(例如,正则表达式和复杂算法通常会在注释中解释它们的作用,会让阅读代码的人受益匪浅),但大多数注释是针对代码本身可能无法包含的信息,比如这些代码背后的缘由。 查看此 CL 之前...
Dir 4.4建议代码的部分不应被“注释掉”(用宏注释,不要用// ,/**/等注释) Dir 4.5建议在同一命名空间中具有重叠可见性的咨询标识应在排版上明确无误(命名相同的地方应该合理区分不要通过改变近似符号区分,比如替换大小写等) Dir 4.6建议指示大小和符号的建议类型定义应代替基本的数字类型。 Dir 4.7要求如果函数...
当您在编写新的分析代码,您需要看下这些底层数据的实例,您写的代码是如何解释这些实例的。不这样做,要用的分析代码复杂一些您基本上就写不出来了。您的分析能从底层数据挖出许多特征,并梳理成有用的总结。通过查看个体实例的全部复杂情况,您会得到合理的总结,从而信心百倍。 您应该做分层抽样,在整个分布中都得到采样...
代码设计 Dir 4.1要求运行时故障应最小化 Dir 4.2建议汇编语言的所有用法都应记录在案 Dir 4.3要求汇编语言应封装和隔离 Dir 4.4建议代码的部分不应被“注释掉”(用宏注释,不要用// ,/**/等注释) Dir 4.5建议在同一命名空间中具有重叠可见性的咨询标识应在排版上明确无误(命名相同的地方应该合理区分不要通过...