对程序员来说,写文档是一件非常痛苦的事情。虽然号称是拥有比非程序员略强的思维逻辑,但本身却对咬文嚼字不感冒。
这里推荐伪代码编程,它可以减少设计和编写文档的工作量,同时却起到了设计文档的作用。
伪代码是指某种用来描述算法、子程序、类或完整程序的工作逻辑的、非形式的、类似于英语的记法。
1. 用类似英语的语句来精确描述特定的操作
2. 避免使用目标编程语言中的语法元素
这点是关键,程序员很容易就进入了角色,混淆了,写的伪代码与真正的代码没什么两样。这就没什么意义了。需要从编码的思维中跳出来,伪代码应该是比代码要高的层次,也可以说是更高的抽象。
3. 伪代码也需要反复迭代
与说明文档类似,伪代码也可以通过不断地迭代,来细化,从高层次到中层次,再到低层次。一个好的伪代码完成之后,真正的代码将会变得容易。
为了保证质量,我们项目组已经实施了在做任务前先由大家一起评审设计方案的方法,效果显著,接下来我们准备更近一步,增加伪代码的评审活动,相信所有人的编码水平肯定会有一个质的飞跃。