version-control - 注释是否显示添加/修改了哪些版本代码有用？-6ren

version-control - 注释是否显示添加/修改了哪些版本代码有用？

转载作者：行者123 更新时间：2023-12-04 01:31:32

26

4

我工作的项目中的一些开发人员习惯于对他们的代码进行注释，以显示它是为哪个版本的产品添加的，例如

// added for superEnterpriseyWonder v2.5
string superMappingTag = MakeTag(extras);
if (superMappingTag.empty())
{
     autoMapping = false;
}
// end added for superEnterpriseyWonder v2.5

每当我看到这个，我的血压就会上升，我必须花 5 分钟浏览 SO 才能冷静下来。在我看来，他们不了解版本控制，如果我也使用这种做法，源文件中的每一行都将是关于何时添加内容的注释。我正在考虑从我处理的文件中删除所有此类评论，但我想知道是否只是我很挑剔，这些评论实际上有一些值(value)吗？

最佳答案

没有任何值(value)。如果您的版本控制中有一个blame 工具，这将实现这一点，它们只会增加噪音。

更糟糕的是，它们会为您的代码吸引更多注释，使其完全不可读

// added for superEnterpriseyWonder v2.5
string superMappingTag = MakeTag(extras);
if (superMappingTag.empty())
{
     // bug fix #12345674 shuld have been true
     autoMapping = true;
     // bug fix #12345674 should have been true
     i++; // v2.6 now need to up the counter DO NOT DELETE
}
// end added for superEnterpriseyWonder v2.5

然后有人会删除该方法，但将代码注释保留在

// added for superEnterpriseyWonder v2.5
     // bug fix #12345674 should have been true
     // v2.6 now need to up the counter DO NOT DELETE
// end added for superEnterpriseyWonder v2.5

对蹩脚的评论说不

关于version-control - 注释是否显示添加/修改了哪些版本代码有用？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/1687190/

26

4

0

文章推荐： .NET 反射 : Detecting IEnumerable

controller - 从另一个 Controller 调用另一个模块中的 Controller
Yii::$app->runAction('new_controller/new_action', $params); 我相信这可以用来从另一个 Controller 调用 Controller Ac
controller - 如何从子 Controller 访问父成员 Controller
这个问题类似于 this ，但我需要访问父成员(不是控制)。我不知道是否可以不使用依赖注入(inject)。例如，我有一个父级，有一个成员调用用户，我需要从子 Controller 访问用户。最佳
controller - 访问另一个 Controller 类中的 Controller
我有包含 2 个布局的根布局:- 选项面板- 绘制区域我正在尝试的是访问 OptionsPaneController 中的 DrawAreaController 以调用其绘制方法。下面是 Optio
iphone - 在 View Controller -> Tab Bar Controller -> Navigation Controller -> View Controller 层次结构中旋转 View Controller
我的应用程序的 View Controller 层次结构设置如下: UIViewController | UITabBarController | UINavigationCo
iphone - 在选项卡栏 Controller -> 导航 Controller -> View Controller 的层次结构中旋转 View Controller
我的应用程序的 View Controller 层次结构设置如下: UITabBarController | UINavigationController | | |
ios - 为什么在导航 Controller 中嵌入 View Controller ，然后在选项卡栏 Controller 中将导航栏附加到选项卡栏 Controller ？
当我第一次为我目前在 Storyboard 中开发的应用程序创建基础布局时，我分两步完成: 选择我的 View Controller 并使用 Editor->Embed In->Navigation
ios - 导航 Controller 内的选项卡栏 Controller ，如何将新的 View Controller 推送到选项卡 Controller ？
设计要求: 显示用户可以选择的项目列表选择一个项目后，使用后退按钮将用户带到一个新 View 。新 View 应在底部包含第一个屏幕中不存在的选项卡列表单击选项卡中的项目时，应出现一个带有后退按钮
angularjs - 获取子 Controller 中的父 Controller ，所有子 Controller 都使用 'controller as vm' 表示法
将父 Controller 设置为“parentCtrl as vm”，并将子 Controller 设置为“childCtrl as vmc”，以避免名称冲突，并且效果良好。如何在子 Contro
ios - Swift 尝试以模态方式呈现事件 Controller [当前 View Controller ]，即使呈现的 Controller 是另一个 Controller
我已经阅读了一些答案，例如关闭当前的 ViewController，但我的情况有所不同，因为我正在展示另一个 ViewController。虽然我无法访问它的属性，但此代码显示了带有导航 Contr
controller - Yii无法实例化 Controller
如我所见，如果我们要实例化一个Model(例如，名为Post)，我们只需调用: $post = new Post(); 现在，我还想实例化一个Controller(例如，名为Post，并为此 Cont
controller - JMeter Controller
我已经疯狂地在整个网络上搜索解决我的问题的方法，但目前还没有。我的问题是我必须检查是否在 HTTP 请求中获得特定文本，该请求在一个 while 循环中，如果我这样做了，那么我应该离开循环并继续线程，
controller - Ember.js 如何获取嵌套 Controller 名称的 Controller
我想用this.get('controllers.pack.query');要得到App.PackQueryController在 App.PackController ，但失败了。我认为问题是 E
controller - 如何在目录中组织 Controller ？
我刚开始使用 Laravel。当我使用 codeigniter 或 zend 框架时，我可以将我的 Controller 组织到一个单独的目录中。例如，我可以创建“user/permission.ph
controller - Emberjs - 如何从另一个 Controller 访问一个 Controller 的方法'
在 emberjs 前 2 我们可以从另一个 Controller 访问 Controller 或 Controller 中的任何方法以下方式: App.get('router').get('nav
ios - 通过 View Controller 、标签栏 Controller 、导航 Controller 和 View Controller 传递数据
这可能是非常简单的实现，但我是 iOS 编程的新手，我似乎被卡住了。所以，基本上，我有一个选项卡式应用程序。我决定除了标签栏之外还需要一个导航栏。为此，我放置了标签栏 Controller ，然后添
jquery - Angularjs Controller : how to call a controller in another controller?
我有这个列表 Controller ， define([ 'jquery', 'app' ], function ($,app) { app.controller("ListC
swift - 从一个 Controller 导航到另一个 Controller ，它们之间有一个根 Controller
我有 3 个 Controller :RootController、FirstController 和 SecondController。我想从 RootController -> FirstCont
ruby-on-rails - Controller 测试 : RuntimeError: @controller is nil. 如果 Controller 在子文件夹中，如何引用 Controller ？
我有以下 Controller : /controllers/api/base_controller.rb /controllers/api/v1/articles_controller.rb 当为文
javascript - 类型错误 : $controller is not a function + Controller inside controller
我是 Angular JS 的新手，尝试在另一个 Controller 中调用一个 Controller ，但出现以下错误。 ionic.bundle.js:21157 TypeError: $con
ios - 当我从一个 View Controller 展开到另一个作为选项卡栏 Controller 子级的 View Controller 时，如何显示选项卡栏 Controller ？
我有一个标签栏 Controller 和它的 3 个 child ，我还有另一个 View ，我制作了一个从 child 到 View Controller 的自定义转场，还有一个从 View Con

首页

博学

6Ren·AI

商城

version-control - 注释是否显示添加/修改了哪些版本代码有用？