version-control - 出于历史目的注释掉代码的替代方法-6ren

version-control - 出于历史目的注释掉代码的替代方法

转载作者：行者123 更新时间：2023-12-04 02:06:22

25

4

出于可查找性的原因，是否有人有使用已注释掉的代码 checkin 存储库的有效替代方法？

我问的原因是因为我最近与一位开发人员讨论了 checkin 被注释掉的代码。我的立场是，注释掉的代码永远不应该被检查到我们的 VCS 中，因为它在技术上不是代码库的一部分，因此可以这么说，它不值得它占用的字节数。

他的反对意见是，他 checkin 的一些注释掉的代码仍然说明了他将来想要修复的一些工作(在这个特定的点上，注释掉发生在 2 年前，但这不是重点)。他想把它保存在代码库中，这样他就可以很容易地找到它，即使它当前不能编译，它仍然在全局行中显示了解决它的正确方法。

最后他同意，有点，注释掉的代码不属于。但是当我们考虑可能的替代方案时，我们的想法很短。

我能想到的唯一选择是:

维基 : 只需将其粘贴到 wiki 上的某个位置即可。这样做的缺点是它会与其他非代码相关的 wiki 内容混合在一起，这可能会使搜索变得困难。

索引所有 VCS 修订版 :这对我来说主要是理论性的，但是是否有系统可以使代码库及其整个历史可搜索？

有谁知道/使用任何替代品？我的两个选择听起来都比实际值(value)要多，但这可能会被我的推理所歪曲，即注释掉的代码无论如何都是毫无值(value)的。我不想走“嘿，如果你现在没有时间修复它，无论如何留在代码库中都不够重要”路线(但如果没有可行的替代方案，我会这样做)。

对不起，标题太糟糕了，我想不出更好的了

最佳答案

分支在这里很有用。使用 SCM 的一种模式是为每个功能创建一个分支。当分支合并没有痛苦时，这很受欢迎 - 所有 SCM 都无法提供这种便利...... :-)

这个想法是，您处理的每个功能都有一个专用分支，并且完全在该分支内处理。当该功能完成、工作、测试、记录并获得两枚奥运金牌等后，分支将合并到主干中。或者，如果功能从未完成或放弃等，分支将无限期地保持打开状态。但是代码仍然可见，准备好在某一天被某人使用。

这是存储“正在进行的工作”的好方法 - 因为代码是分支的，您可以自由地检查暂定代码。它不需要被注释掉，因为正在进行的更改只在那个孤立的分支中，甚至不需要编译，因为这些分支通常在它们达到成熟水平之前不会迁移到持续集成中。

与注释掉的代码不同，这些暂定的代码更改是可见的和可搜索的，适用于代码分析工具、重构等。

在某些环境中，功能及其分支也可能具有关联的更改票证或问题跟踪 ID。这可确保不会丢失重大更改，并提供了一种对各种功能进行优先级排序和组织的方法，从修复程序到尝试以一种可能永远不会出现的不同方式实现某些功能。

至于搜索，一些 SCM 有一个搜索前端。例如，SVN 有 SVNSearch
- http://sourceforge.net/projects/svn-search/ .还有svnquery ，既可以搜索历史，也可以搜索头部。

关于version-control - 出于历史目的注释掉代码的替代方法，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/2972907/

25

4

0

文章推荐： multidimensional-array - 用 C 打印二维数组

文章推荐： scala - scala闭包/匿名函数中的多个返回点

文章推荐： .net - HttpWebRequest.UserAgent : What does it do

文章推荐： Clojure 或 Scheme 贝叶斯分类库？

Ruby 方法() 方法
我想了解 Ruby 方法 methods() 是如何工作的。我尝试使用“ruby 方法”在 Google 上搜索，但这不是我需要的。我也看过 ruby-doc.org，但我没有找到这种方法。
VBS教程：方法-Test 方法
Test 方法对指定的字符串执行一个正则表达式搜索，并返回一个 Boolean 值指示是否找到匹配的模式。 object.Test(string) 参数 object 必选项。总是一个
VBS教程：方法-Replace 方法
Replace 方法替换在正则表达式查找中找到的文本。 object.Replace(string1, string2) 参数 object 必选项。总是一个 RegExp 对象的名称。
VBS教程：方法-Raise 方法
Raise 方法生成运行时错误 object.Raise(number, source, description, helpfile, helpcontext) 参数 object 应为
VBS教程：方法-Execute 方法
Execute 方法对指定的字符串执行正则表达式搜索。 object.Execute(string) 参数 object 必选项。总是一个 RegExp 对象的名称。 string
VBS教程：方法-Clear 方法
Clear 方法清除 Err 对象的所有属性设置。 object.Clear object 应为 Err 对象的名称。说明在错误处理后，使用 Clear 显式地清除 Err 对象。此
VBS教程：方法-CopyFile 方法
CopyFile 方法将一个或多个文件从某位置复制到另一位置。 object.CopyFile source, destination[, overwrite] 参数 object 必选
VBS教程：方法-Copy 方法
Copy 方法将指定的文件或文件夹从某位置复制到另一位置。 object.Copy destination[, overwrite] 参数 object 必选项。应为 File 或 F
VBS教程：方法-Close 方法
Close 方法关闭打开的 TextStream 文件。 object.Close object 应为 TextStream 对象的名称。说明下面例子举例说明如何使用 Close 方
VBS教程：方法-BuildPath 方法
BuildPath 方法向现有路径后添加名称。 object.BuildPath(path, name) 参数 object 必选项。应为 FileSystemObject 对象的名称
VBS教程：方法-GetFolder 方法
GetFolder 方法返回与指定的路径中某文件夹相应的 Folder 对象。 object.GetFolder(folderspec) 参数 object 必选项。应为 FileSy
VBS教程：方法-GetFileName 方法
GetFileName 方法返回指定路径（不是指定驱动器路径部分）的最后一个文件或文件夹。 object.GetFileName(pathspec) 参数 object 必选项。应为
VBS教程：方法-GetFile 方法
GetFile 方法返回与指定路径中某文件相应的 File 对象。 object.GetFile(filespec) 参数 object 必选项。应为 FileSystemObject
VBS教程：方法-GetExtensionName 方法
GetExtensionName 方法返回字符串，该字符串包含路径最后一个组成部分的扩展名。 object.GetExtensionName(path) 参数 object 必选项。应
VBS教程：方法-GetDriveName 方法
GetDriveName 方法返回包含指定路径中驱动器名的字符串。 object.GetDriveName(path) 参数 object 必选项。应为 FileSystemObjec
VBS教程：方法-GetDrive 方法
GetDrive 方法返回与指定的路径中驱动器相对应的 Drive 对象。 object.GetDrive drivespec 参数 object 必选项。应为 FileSystemO
VBS教程：方法-GetBaseName 方法
GetBaseName 方法返回字符串，其中包含文件的基本名 (不带扩展名), 或者提供的路径说明中的文件夹。 object.GetBaseName(path) 参数 object 必
VBS教程：方法-GetAbsolutePathName 方法
GetAbsolutePathName 方法从提供的指定路径中返回完整且含义明确的路径。 object.GetAbsolutePathName(pathspec) 参数 object
VBS教程：方法-FolderExists 方法
FolderExists 方法如果指定的文件夹存在，则返回 True；否则返回 False。 object.FolderExists(folderspec) 参数 object 必选项
VBS教程：方法-FileExists 方法
FileExists 方法如果指定的文件存在返回 True；否则返回 False。 object.FileExists(filespec) 参数 object 必选项。应为 FileS

首页

博学

6Ren·AI

商城

version-control - 出于历史目的注释掉代码的替代方法