code complete part1

时间:2022-05-24 00:57:24

最近在看code complete,学习了一些东西,作为点滴,记录下来。

关于类:

类的接口抽象应该一致

类的接口要可编程,不要对类的使用者做过多的假设。不要出现类似于:A的输入量一定要大于多少小于多少,一定要在某个函数前call之类的限制,而应该在assert等地方加入这些判断,让代码去做限制,而不是注释。

代码阅读的次数要比写的次数多得多

类的成员变量表征类拥有怎样一个属性

类的继承表征类还可以有另一个特殊的版本

类用到的其他类的次数叫做扇入(fan in),越少越好

要在构造函数中对所有的成员变量初始化

如果需要类的构造函数是私有的,并强制规定只能有一个对象实例的话,需要用如下代码

class A:

private A(){..}

public static A GetInstance()

{

return m_A;

}

private static A m_A = new A();

....

如果有些类只有数据,没有行为(get ... set ..),这样的类真的就没有必要了

子程序:

在某些经常会用到的代码,应该成为一个子程序,避免重复

子程序应当小于200行

可以在子程序的参数前表明 _in_ _out_ Inout_等关键字

子程序参数小于7个

防御式编程:

当用户的输入非法时,怎么处理。

几种方法:assert, error handle, exception, barrier.

assert主要用于程序内部的错误

error handle是用于在用户输入了一个非法的值,程序内部除了返回错误,为了不导致程序无法运行下去,需要做的一些WA,例如,用上一次的值,返回一个错误代码,print trace log, 返回一个中立值等

程序的正确性与鲁棒性是trade off

可以分层级来处理错误,如,底层代码只负责报告错误,由高层代码统一处理错误

barrier的方法是说,设定一个隔离层,专门对输入量进行validate,如果满足条件后,进入系统,则之后用assert

伪代码编程:

这是一种有效的编程方法,很多初级程序员的编程方法是这样的,先东平西凑,然后通过运行来看代码是否正常工作,这种开发方法效率低,应当等代码自己确认无误之后,再进行编译与运行,请避免在匆忙中完成代码

变量:

一个变量只表示一个意思,不要说int a ,当a <-1时表明有错误。。这时候,应当加一个变量