最终,代码将(最终)编译成CPU的指令.然而,代码(以我的拙见)是为了让人类阅读,更新和互动.这引出了以下观察:
其他工程师无法读取的代码,即使它的功能正常,也是错误的代码.
考虑到这一点,这个程序员可以做些什么来使人们更容易阅读代码？
命名约定？(乔尔有相当多的说法)
代码结构/布局？(请为了上帝的爱,不要进入{安置辩论)
分句？(是否可以编写看起来更像英语的代码)
我正在研究一些C++代码,其中我有几个私有方法的管理器对象,如
void NotifyFooUpdated();
它OnFooUpdated()在该对象的侦听器上调用该方法.
请注意,它们不会修改此对象的状态,因此它们在技术上可以成为const方法,即使它们通常会修改整个系统的状态.特别是,侦听器对象可能会回调此对象并对其进行修改.
就我个人而言,我想留下它们,而不是宣布它们const.
但是,我们的静态代码检查器QAC将此标记为偏差,因此我要么必须声明它们const,要么我必须争论为什么它们应该保持非常量并获得偏差的授权.
没有声明这些方法的论据是什么const？
或者我应该关注QAC并宣布它们const？
我应该采用仅限于此对象的严格本地观点,还是将系统视为一个整体？