个人行为与观念 - 认真写SVN日志 ¶

• 作者：KK

• 发表日期：2016.5.28

其实这里不止是SVN,就算是Git等代码仓库的日志都是

不填日志的家伙 ¶

当参与团队协作的项目时,如果你提交代码时并不填写提交日志,那么谅你再懂多少插件多少函数API都好,只要不填写日志,你始终还是不如团队中略有见识的工程师

写几个字的家伙 ¶

如果你填写日志,那不错是有一点儿进步,然后这个阶段你可能会填写得比较简单,比如你今天针对一个商品详情页面植入了团购功能并优化了一些旧的逻辑,但提交时只是简单地写上"团购"两个字,那你只是能基本表达出本次修改主要的内容是什么,但是其它比如"用户中心","删除用户","增加积分","优化"类似这些我相信你也写了不少,这有一定的模糊性,有时候会让人猜不着一些具体的东西

希望你可以写得更加详细一点

更加敷衍的家伙 ¶

这种情况比较可恶,他的提交日志大部分都是"优化代码","添加功能","test"等等,基本上等于没填

带来的麻烦 ¶

• 管理者对项目代码的演变追溯困难,虽然这种需求很少

• 某个程序文件工作不正常的时候,想起以前是正常的,可是以前那个代码状态不知是什么时候,大概记得是改了什么,但不记得具体修改的日期时间了,一天天的日志看吧又像大海捞针,其实此时最需要的就是靠日志内容来快速定位

• 审核代码时欠缺了一些参照信息,当要审核这次变更涉及什么内容时,根本无法从日志上知道,只能从代码差异上判断有A,B,C变更,有的代码看不出是干什么的,而日志又没有,是不是要人家打电话亲自咨询?

以下是我的写的日志记录 ¶

所以如果我的上司要看我的代码修改记录,那么他绝对会强烈地意识到我比他人写的更加优秀,至少超越了好一部分人