编写代码软件开发中必须注意的编码版本控制问题
更新时间:2015-06-27 18:39:55浏览次数:1+次
本文是实际开发经验总结,对于代码版本,有几种控制,编写详细的实现文档、备份项目文件和注释代码而不是删除代码。
这里并不是介绍什么版本控制系统,这里说的是与程序员每时每刻的编码息息相关的东西。而代码删掉之后,出了残留在脑中的一个大概思路外,具体细节就不知道了。
先解释一下我想说的东西是什么。
在我们开发一个功能时,在完美完成之前,必然会有各种Bug,多种实现方案技巧。每一种方法都可能有瓶颈,所以我们经常会在几种方法中寻找最好实现的一个。或者,我们可能会对一个功能写多个版本,直到完善或者持续升级。
所以问题就来了。在多次修改代码时或多次升级功能或者重写代码时,你是如何做的呢?
对于这个问题,我们需要特别注意。因为我又一次碰到,且让我很头疼。之前能够正常工作的,后来再修复其他功能时也不知道怎么回事,现在竟然不能正常工作了。仔细去检查,也无济于事,除非重头来修复或者实现这个问题。而之前的代码也是被修改的失去了真面目,没有一个成功运行时的备份,因此就悲剧了。对于已经实现过的东西,因为比较麻烦,又因为时隔一段时间,都既不太清楚了。这也是没有对这种实现方式做好记录。这里也提醒一下,对于绞尽脑汁想到的办法,或是自己奇思妙想,反正不是常规的办法,日后很难想起的实现方法,一定要写个文档记下自己的实现过程,否则就是叫天天不应叫地地不灵了。你自己的实现方法,人家可不知道,问也没有用,自己也想不起来了。并且对于这种问题,再想一次,也是很痛苦的了。所以做好记录是一个极好的习惯。
一次不注意就带来了这么多的代价。哎,所以,在此,只能提醒各位做好防范。
如果在文档缺失或者懒得写文档或者是维护他人的代码时,那就要做好第二步。对原始代码全部备份一个。你在这个代码上继续加功能,可能不经意间就破坏了原有的功能,而你并不知道。所以,备份是非常重要的。备份也是可以让你的代码在写乱的时候可以回溯,安全可靠。否则一个项目的代码,本来只有三个,却被你写出了几十个,你就完蛋了。此时就只要一招。也就是最好的一招,直接用备份的项目重新开发。或者用原始的项目代码来与现在项目代码比对,找出写错的位置,试图恢复。
当然,什么时候备份也是很值得一提的。当然,最原始的一份,无论如何都要保留。然后没开发一部分功能,就要备份一次,标上日期和添加修改说明,以便日后查询比对。当然,多少功能备份一次,就看功能影响的范围了。如果一个功能影响的范围很大,或者对功能一处修改会到处受影响,那么,一定要备份一下。否则一不小心,就全乱了。这时想恢复,就难了。
当然,如果你对这个功能没有把握,最好时备份一下。同时,及时记录开发日志,以备查询。
这些都不是形式主义,这里并不是要你按照什么格式写所谓的日志,就是你要写出你自己实现的思路和需要注意的细节,后面维护就好说了,否则就等着麻烦找上门吧。如果习惯不好,代码越写越多,连自己也就越写越不敢写了。
还有一个习惯,那就是,对于前面觉得有问题的代码,或者是要换一组代码实现同一个功能时,记着,不要急着删掉这个代码,而是注释掉这个代码。在我的大量编码实践中发现,我经常喜欢删掉不需要的代码,而不久又要用这些代码,导致又要重新写一遍前面删掉的代码。有时候,删掉之后记不清前面的代码了。而这个过程中,前面的代码只是一个小错误,稍微修复就可以了。但是因为删掉了,很是郁闷。
那什么时候删掉这些你觉得没有用的代码呢?那就是你这部分的功能完全实现,没有Bug的时候,为了代码简洁美观,可以删掉。如果代码还有价值,以后可能用上,可以保留注释或者写一下总结,以免遗失。C++技术网将会积累大量程序员的经验总结,也希望你对这些经验的总结也分享给大家哦。自己日后也方便查询。
一次失误和大意,这两天都没有恢复出那个功能,郁闷死了。分享给大家,希望大家注意了。我还要继续解决,实在不行,之前的工作全部就白费了。要么就重头来想想之前的思路,要么就不用这种方法了。不过之前好像是其他方法都有瓶颈,才用了很多时间才想出来的。这下有得玩了。