gpt4 book ai didi

coding-style - 修订历史和记录更改

转载 作者:行者123 更新时间:2023-12-05 00:06:58 25 4
gpt4 key购买 nike

我在遗留系统上工作,我曾经在源代码中看到每个版本都被修改的文件或函数的修订历史,例如:


//
// Rev. No Date Author Description
// -------------------------------------------------------
// 1.0 2009/12/01 johnc <Some description>
// 1.1 2009/12/24 daveb <Some description>
// -------------------------------------------------------
void Logger::initialize()
{

// a = b; // Old code, just commented and not deleted
a = b + c; // New code

}

我只是想知道这种记录历史的方式今天是否仍然被许多人采用?如果是,您如何对源代码进行修改 - 您是对其进行评论还是将其完全删除?

如果没有,记录这些修订的最佳方式是什么?如果您使用版本控制系统,那么您的源文件是否包含纯源代码,除了必要时的注释(没有每个功能的修订历史记录等)?

最佳答案

只需依靠您的版本控制系统即可。是的,只是纯源代码。如果代码被注释掉,我将其删除。如果我不确定我将它留在那里并带有 TODO 评论。
我不会在源代码中而是在提交消息中插入注释以引用票证。您不需要在代码中记录它过去的样子。

关于coding-style - 修订历史和记录更改,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2589848/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com