code complete part1

最近在看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时表明有错误。。这时候,应当加一个变量

时间: 2024-11-05 11:44:59

code complete part1的相关文章

《Code Complete》ch.23 调试

WHAT? 调试——发现错误的一种手段 WHY? 相对于不善于调试的程序员,善于调试的程序员只需要前者1/20的时间就可以找出问题所在 HOW? 科学的调试方法 把错误的发生稳定下来:假设-证实/证伪 确定错误原因:二分法 同他人讨论问题 忏悔式调试 抛开问题,休息一下 修正问题 动手之前先要理解问题 理解程序本身,而不仅仅是问题 验证对错误的分析 放松一下 治本,而不是治标 修改代码时一定要有正确的理由:不要随机地修改代码,在没有理解代码时对她做的改动越大,你对她能正确工作的信息就越低 检查自

《Code Complete》ch.11 变量名的力量

What? 如何给变量命名 Why? 易读(你三个月前的代码=别人的代码),易记,恰如其分 整齐的命名具有美感,强迫症患者居家旅行杀人放火之必备 How? 以问题为导向 好名字反映的是问题(what),并非解决方案(how).名字不应体现计算细节 // good Object studentData; int sum; // bad Object inputData; int calcValue; 控制变量名长度 合适的变量名长度为10-16个字符 较长的名字适用于少用到的全局变量,较短的名字适

《Code Complete》ch.25 代码调整策略

WHAT? 本章讨论程序性能调整问题.但是对用户来说,程序员按时交付软件,提供一个清爽的用户界面,避免系统经常死机常常比程序性能更加重要 WHY? 在程序设计这种文化中,编写出能够节省几微秒的代码可以证明你很酷-- HOW? Pareto法则 即80/20法则,指你可以通过20%的努力获取80%的成果 一些无稽之谈 在搞基高级语言中,减少代码行数可以加快代码执行速度 特定运算可能比其他的更快,代码规模也较小:在某个环境下提升程序性能的方法放到另一个环境中可能会损害程序性能.在调整代码的时候你实际

《Code Complete》ch.18 表驱动法

是什么 一种scheme,用表来做信息存取,代替逻辑语句(if/else) 为什么 简化逻辑语句,避免大量嵌套的 if/else 或者 switch/case 怎么用 三种访问表的方式 直接访问:将源数据作为key 索引访问:构建KV表 阶梯访问:分为连续区间,遍历或者二分查找 例子 // get the full name of weekday // good String[] weekdays = { "Sunday", "Monday", "Tues

《Code Complete》ch.24 重构

WHAT? 重构(refactoring),Martin Fowler将其定义为“在不改变软件外部行为的前提下,对其内部结构进行改变,使之更容易理解并便于修改”. WHY? 神话:一个管理很完善的软件项目,应该首先以系统化的方法进行需求开发,定义一份严谨的列表来描述程序的功能.设计完全遵循需求,并且完成的相当仔细,这样就让程序员的代码编写工作从头到尾直线型地工作.表明绝大多数代码首次编写后就已完美,测试通过即可被抛诸脑后.代码被修改的惟一时机发生在交付使用后在新版本进行功能的添加 现实:在初始开

《Code Complete》ch.8 防御式编程

WHAT? 主要思想:子程序不应因传入参数错误而被破坏 WHY? 保护程序免遭非法输入的破坏 HOW? 断言 assert denominator != 0 : "denominator should not be 0"; // 启动VM时需要 -ea 参数用以启动assert功能 只用于开发.维护阶段 用错误处理代码来处理预期会发生的状况,用断言来处理绝不会发生的状况 避免把需要执行的代码放入断言中 用断言来注解并验证前条件和后条件 错误处理技术 返回中立值(当对返回结果准确性要求较

《Code Complete》ch.7 高质量的子程序

WHAT? 子程序(routines)是为实现一个特定目的而编写的可被调用的方法或过程.在C++中是函数(function),在Java中是方法(method),在VB中是函数过程(function procedure)或子过程(sub procedure). WHY? 降低复杂度 引入中间.易懂的抽象 避免代码重复 支持继承.重写 隐藏实现细节 提高可移植性 改善性能(对明确的子程序进行优化) HOW? 内聚性(cohesion):是指子程序中各种操作之间联系的紧密程度 编程的目标是让每一个子

《Code Complete》ch.20 软件质量概述

WHAT & WHY ? 软件质量的特性 外在特性 正确性(Correctness) 可用性(Usability) 效率(Efficiency) 可靠性(Reliability) 完整性(Integrity) 适应性(Adaptability) 精确性(Accuracy) 健壮性(Robustness) 内在特性 可维护性(Maintainability) 灵活性(Flexibility) 可移植性(Portability) 可重用性(Reusability) 可读性(Readability)

《Code Complete》ch.29 集成

WHAT? 集成是这样一种软件开发行为:将一些独立的软件组合为一个完整的系统. WHY? 更容易诊断缺陷 尽早获得一个可工作的产品 更好的顾客关系 增强士气 更可靠地估计进度表 更准确的现状报告 HOW? 集成的两种方式 阶段式集成(爆炸集成) 增量集成(滚雪球集成) 增量集成的策略 自顶向下(Top-Down):使用底层stub类,逐渐替换为实际的类.若底层接口实现起来有bug,或者有性能问题,会导致顶层设计变更 自底向上(Bottom-Up):“让底层细节驱动高层类的设计”违反了信息隐藏原则