Blog

项目体验

我们《软件工程》课上的项目作业快到了第一阶段的截止日期了,因此近期我们的工作量都大了起来。之前我从来没与别人合作写过程序,也从来没有写过复杂逻辑的程序(从来没用过Java的package),因此这次也学到了很多。

今天我花了一天的时间在完善项目上,感觉到了一个比较严重的问题──怎么也想不起来这个函数是什么时候写的、谁写的以及做真么用的了。每次遇到这种情况,我都要从项目的第一天回溯过来,想这段代码是怎么演化到今天的。如果是自己写的还好说(我们两人写后端,绝大多数的代码都是我输入的,同伴主要出谋划策与设计算法,因此印象比较深刻),但由于我们两人的代码量较大,另两个人完成他们的部分后,开始帮忙做我们的部分,有时他们会改动一些内容,这就常常让我困惑不已。

今天把多数工作都完成了后,我决心改善这种状况──为几乎每一个函数都写Javadoc。几乎的意思是除了一些非常明显的accessor外,每一个都注明用途、变量性质、返回值性质等说明。这样的好处有二:一是在将来忘了函数作用后可以方便的查看Javadoc;而是因为我为每一个函数都加上了注释,也相当于我又从头开始复习了一下整个程序,对整体的了解也更进了一步。

1 comment

  1. 为项目填写迭代细节 | 我的空想特摄 - pingback on 2012/01/15/ 21:30
    沙发

Leave a Reply