竭诚为您提供优质文档双击可除
sv
提交注释规范
篇一sV
版本管理与提交代码规范
sV
版本管理提交代码规范
项目开发要求
1、工作目录要及时更新不要和sV
服务器有太大的差别
2、提交代码时如果出现冲突必须仔细分析解决不可以强行提交
3、提交代码之前先在本地进行测试确保项目能编译通过且能够正常运行不可盲目提交
4、必须保证sV
上的版本是正确的项目有错误时不要进行提交
sV
注意事项请严格按照操作顺序操作避免提交代码导致重大事故
一提交之前先更新
1sV
更新的原则是要随时更新随时提交。当完成了
f一个小功能能够通过编译并且自己测试之后谨慎地提交。
2如果在修改的期间别人也更改了sv
的对应文件那么commit就可能会失败。如果别人和自己更改的是同一个文件那么update时会自动进行合并如果修改的是同一行那么合并时会产生冲突这种情况就需要同之前的开发人员联系两个人一起协商解决冲突解决冲突之后需要两人一起测试保证解决冲突之后程序不会影响其他功能。
3在更新时注意所更新文件的列表如果提交过程中产生了更新则也是需要重新编译并且完成自己的一些必要测试再进行提交。这样既能了解别人修改了哪些文件同时也能避免sV
合并错误导致代码有错
二保持原子性的提交
每次提交的间歇尽可能地短以几个小时的开发工作为宜。例如在更改ui界面的时候可以每完成一个ui界面的修改或者设计就提交一次。在开发功能模块的时候可以每完成一个小细节功能的测试就提交一次在修改bug的时候每修改掉一个bug并且确认修改了这个bug也就提交一次。我们提倡多提交也就能多为代码添加上保险。
三提交时注意不要提交本地自动生成的文件
一般配置管理员都会将项目中一些自动生成的文件或
者与本地配置环境有关的文件屏蔽提交例如eclipse中的classpath文件等。如果项目中没有进行这方面的配置
f来强行禁止提交这样的文件请自觉不要提交这样的文件。提交了这样的文件后别人在更新后就可能与本地的环境冲突从而影响大家的工作。
四不要提交不能通过编译的代码
代码在提交之前首先要确认自己能够在本地编译。如果在代码中使用了第三方类库要考虑到项目组成员中有些成员可能没有安装相应的第三方类库。项目经理在准备项目工作区域的时候需要考虑到这样的情况确保开发小组成员在签出代码之后能够在统一的环境中进行编译。
五不要提交自己不明白的代码
代码在提交入sV
之后你的代码将被项目成员所分享。如果提交了你不明白的代码你看不懂别人也看不懂如果在以后出现r