Coding style 我应该做一些表面上的改变吗?

Coding style 我应该做一些表面上的改变吗?,coding-style,version-control,commit,Coding Style,Version Control,Commit,有一些我经常想提交给源代码管理的小的编码样式更改,但是现在更改日志中充满了那些不影响代码功能的更改 下一次我需要解决一些小问题时应该怎么做,例如: 移除和排序使用(在.NET中,在python中导入,在c++中包括) 正确的缩进、间距和换行 这些“次要”问题是否得到了解决?如果是,请提交。如果没有,不要 真的,这取决于你和你的团队认为重要的是什么。 < P>把他们作为下一个重大改变作为旁观者。至少我会这么做。如果您要更改代码文件,我真的不明白您为什么不想提交和共享这些更改。如果你不这样做,你就

有一些我经常想提交给源代码管理的小的编码样式更改,但是现在更改日志中充满了那些不影响代码功能的更改

下一次我需要解决一些小问题时应该怎么做,例如:

  • 移除和排序使用(在.NET中,在python中导入,在c++中包括)
  • 正确的缩进、间距和换行
这些“次要”问题是否得到了解决?如果是,请提交。如果没有,不要


真的,这取决于你和你的团队认为重要的是什么。

< P>把他们作为下一个重大改变作为旁观者。至少我会这么做。

如果您要更改代码文件,我真的不明白您为什么不想提交和共享这些更改。如果你不这样做,你就有可能被其他人修复,然后与你的发生冲突


如果它们不是其他用户希望在代码库中进行的更改,也许您应该问问自己为什么要花时间编写它们。

不要将它们与不相关的修复一起提交

我会提交它们,但会在提交消息中添加一些预定义的关键字。生成更改日志时,可以忽略带有此关键字的消息

例如,您可以使用像
[cleanup]
这样的前缀

[cleanup] Removed some whitespace
[cleanup] Changed format
Fixed some major bug.
[cleanup] Corrected indentation

在我是唯一的开发人员的项目中,我倾向于做这些修复以及其他代码更改

在有我们团队的项目中,我倾向于自己尝试并提交此类更改,这样它们就不会掩盖“真正的工作”


我觉得用代码库修复所有“错误”是很重要的,即使它只是缩进之类的小问题

进行提交,并适当标记提交注释,以便在浏览更改列表时更容易忽略


不要将它们提交到与功能更改相同的操作中。这样,如果您确实破坏了某些东西,那么就更容易缩小破坏它的范围,并且在必要时很容易恢复重构。

我喜欢经常提交。当然,任何时候都有明显的变化。那样很容易。如果您开始划分代码段并尝试尽早提交一些代码段,那么最终您将忘记提交一些非常重要的代码段


简而言之:经常提交并始终记录更改。当有巨大的变化时,给它贴上标签。

我认为这取决于你的工作环境以及从事同一项目的其他人如何处理可能不同的问题

因此,我的一般建议是询问使用相同代码的人员,并为类似情况提供指导。您可能会发现,人们并不介意由于表面上的更改而签入,或者他们宁愿生活在一点“不准备”的环境中,而不愿处理杂乱无章的更改日志

一个对每个人都透明的明确指导方针是处理这些问题和避免将来出现混乱的最佳方式


就我个人而言,我喜欢整洁的代码,也不介意纯粹因为表面上的改变而签入。然而,如果只是一点间距和换行符,我可能就让它去做,并且只在我处理同一个代码文件时才对它进行更改。我经常删除和排序using,因为如果有一大堆using没有意义,我会感到困惑,但那只是我自己。

肯定会提交它们。如果您将它们与真正的代码更改一起提交,并且必须回滚这些更改,那么您将丢失外观修复


理想情况下,提交应该类似于数据库事务:一块相关的工作代码,可以在不影响系统其余部分的情况下回滚。

有几个问题

首先,不要修改代码,因为你很无聊,没有足够的实际任务。如果是这样的话,去和你的项目经理谈谈,让他们给你分配一些真正的任务,一些有价值的东西

换句话说,不要为了改变而改变代码。始终在过程中为代码添加一些值

现在,如果这些更改有助于使代码更易于由您和其他人处理,那么请执行这些更改。比如确保遵循命名标准、重构粗糙的代码等,但要为它找一个任务,这样你的项目经理就可以说“是的,这很好,花两个小时做这个,然后再联系我。”

完成更改后提交更改。不要将它们与您在它们之前完成的任何实际任务或下一个任务放在一起,这将使分支之间的错误修复、代码审查和一般代码浏览变得难以遵循

“好的,您修复了错误7711,还更改了大约100个其他文件。很好,那么这里的错误修复是什么?”


我认为,当你有一个开发团队在处理同一个代码时,最重要的是为代码商定一种修饰风格。因此,您的第一项任务是让您的整个团队就编码风格达成一致

祝你好运

一旦你做到了这一点,尽可能经常地进行表面上的改变,以提醒人们坚持这种风格


完整的代码中有一个关于不同编码风格的优点的章节。如果您能让您的团队在编码风格会议之前阅读该部分,这可能有助于让您全部离开会议,集中讨论。

如果更改内容可能会引起争议(例如括号的位置),那么请确保您已与团队其他成员商定了代码风格。不要只是把它改成你自己喜欢的风格,然后再登记。否则,其他人可能会将其更改回并检查他们的更改,然后您将其更改回您的方式

不要仅仅为了承诺而承诺。我通常为我正在编写的代码添加这些代码。例如,如果我正在修复方法a中的一个bug,那么我也要确保进行所有外观上的更改

在我看来你们缺少c