代码管理的建议

如何管理好你的源代码的十条建议

发表于：2012-03-12来源：开源中国社区作者：不详 标签：源代码管理;vss

源代码管理是我们工作中很重的一部分，是很多开发组的生命。但是我们往往在这方面犯错，不理解很多基本的，核心的版本控制的概念。 我在这里列出了十条建议，可以说是戒律。虽然我会用 Subversion 和 .NET 来做示例，但这些戒律和你用的编程语言还

　　源代码管理是我们工作中很重的一部分，是很多开发组的生命。但是我们往往在这方面犯错，不理解很多基本的，核心的版本控制的概念。

　　我在这里列出了十条建议，可以说是戒律。虽然我会用 Subversion 和 .NET 来做示例，但这些戒律和你用的编程语言还有源码管理工具无关。

　　1. 彻底抛弃 VSS!

　　VSS 已死，就让它离去吧。它曾经很有用，但是现在其他 VCS(Version Control System)已经远远超越了它。微软也决定从明年开始不再支持 VSS 了。

　　老实说，在 1995 年，VSS 是一个伟大的工具，但是它的光环早已被它的晚辈，Subversion，Git 和 Mercurial 夺去。

　　2. 没有进入版本库，它就不存在

　　你应该每天把这条念一遍 �C “工作进展的唯一标准就是代码进了版本库”。在代码进入版本库之前，它相当于不存在。

　　我承认你的代码藏在你机器的某个角落，但是对于其他人来讲，这有何意义?他们不能拿到你的最新版本，他们不能和你的版本合并，你也不能部署你的代码，一旦你的硬盘坏了，一切将烟消云散。

　　如果你坚持的执行这一条的话，你会发现其他的好习惯会随之而来。你会自觉的把任务分成小块所以你可以经常提交代码。你会更加频繁的更新，集成代码。最重要的是，经常提交代码说明了你正在做东西。

　　3. 尽早提交，尽快提交，经常提交

　　紧接上面一点，防止“幽灵代码”(只在你本地机器上能看到的代码)的唯一的方式就是把代码尽快的提交到版本库。这么做还有以下好处：

　　▲每次提交都会生成一个新的版本，给你回滚的机会。假如你把代码搞乱了，你是希望回滚到一小时前还是一个星期前?

　　▲间隔的时间越长，代码合并越困难。合并代码从来不是一件好玩的事情。当你好几天都不提交代码，你会突然发现，你已经累计了 50 个冲突要解决，你大概会疯掉。

　　当你坚持经常提交代码的习惯以后，你会发现你的工作、代码提交会呈现出一定的规律。这个规律可以用来指导你的开发工作。当你发现你的团队好几天都没有代码提交的时候，你就会意识到 “something is wrong”。

　　4. 在提交前检查你的更改

　　提交代码到版本库看起来太简单了。反正在项目的根目录往下有东西更改了，提交吧!这样会导致你提交了一堆垃圾。很多人看到下面的对话框的时候，往往是选择所有，然后搞定!于是你的代码库就被污染了，例如 debug 文件夹之类的。

　　还有一些情况是人们提交代码前不检查自己到底更改了什么。例如一个项目配置文件，你会记得你改了什么吗?也许这次修改就不应该提交呢?如下图所示，这个 Web.config 文件为什么被修改了?你可以通过 SVN 工具对比来查看更改。对于一些可能被更改但是不需要进入版本库的文件，例如 Thumbs.db，你可以用 SVN 的“ignore”功能来排除它。

        5. 认真填写“commit messages”

　　填写 commit message(提交注释)是有一点枯燥，但是想象一下别人看你的提交注释的时候是拿着一把斧子，你把他逼疯了他就来砍你!所以不要写“更新了一段代码”这种提交注释，你会把别人逼疯掉。

　　“commit message”的目的解释你提交代码到底修改了什么。你也许不记得你一年前提交的一段代码是为什么，但是 SVN 的注释会让你想起来。

　　所以，请不要写以下这些注释：

　　▲修复了一个 bug

　　▲有一个拼写错误

　　▲更新 1024

　　▲这就是一坨屎

　　▲提交了

　　你还有见过比这个更烂的注释吗?还有，任何一个人的注释应该是不一样的，而且从逻辑上来讲永远不可能一样，因为你每次提交代码的基础一定是不一样的，所以你做的事情不可能一样。

        6. 你必须自己提交代码，而不是让别人代劳

　　这个听起来有些奇怪。但这种事情确实存在，而且我还遇到过不止一次。有一些团队为了保证代码库的干净，让一个人专门负责审核和提交代码。这并不是一个好习惯。

　　首先，源代码管理并不是为了保持代码的纯净，起码在开发过程中不是这样。它的目的是让团队更频繁的集成各自的工作，当有问题的时候可以回退。在这个过程中，并不需要每一步都很完美。只有在版本发布的时候，我们才需要，或者尝试去达到“干净的代码”。

　　还有，从开发者的角度来看，这么做等于没有源代码管理。因为它意味着没有代码集成，没有回退，没有 blame log，什么都没有。你只是坐在那里写代码，然后在你也无法确定的时间把代码交给你的老板。

     7. 编译出来的文件不应该加入版本控制 简单的说，就是任何自动生成的东西都不应该放在版本库里面。以 .NET 为例，所有bin，obj文件夹下面的东西(.dll，

         8. 编译出来的文件不应该加入版本控制

　　简单的说，就是任何自动生成的东西都不应该放在版本库里面。以 .NET 为例，所有“bin”，“obj”文件夹下面的东西(.dll，.pdb 等等)都不应该加入版本库。

　　为什么?因为如果这么做了，你团队的其他人会恨死你的。每次他们更新代码都会用你的编译输出来替代他们的编译输出，会导致他们本地的很多东西不能用。另外一个原因是，你完全没有必要把这些编译输出放在版本控制里面，它们只是在浪费服务器的硬盘和带宽。

       9. 别人不在乎你的个人配置

　　很多时候，人们没有意识到它们正在提交它们自己的个人配置到版本库。开发工具往往会生成一些配置文件，记录你的文件路径，字体设置，快捷键设置等等，这些东西只对你有用。以 .NET 项目为例：

        10. 依赖项也需要添加到版本库

　　虽然这是最后一条，但也是很重要的。如果你的代码需要依赖第三方的类库或者文件，你需要把这些文件也添加到版本库。你不能认为程序在你的机器可以跑，就在别人的机器上也能跑。你团队的其他成员也许没有这些依赖的文件，他们更新了你的代码以后，会导致项目无法编译或者程序无法运行。

　　我今天还遇到一个这样的问题。我拉下了很久以前的一个项目，然后出现下面的编译错误：

　　这个项目是别人开发的，以前的工作环境总是有 NUnit 的，但是现在没有了，所以出现了这些错误。

　　总结

　　这十条的每一条都很简单，老实说都是很基础的东西：及时，尽早的提交代码，充分了解你提交的东西，并确认它们确实需要被提交到代码库，解释你的提交，自己提交自己的代码，不要忘记数据库版本控制，不要忘记依赖项。但请你忘记 VSS ：)