公司的源代码,注释和我的建议

时间:2018-07-28 12:24:55

标签: comments

最近我在办公室中无法处理源代码管理。

我们有一个供应商为我们提供基准代码,而我的工作是利用我们公司的业务逻辑对其进行扩充。以我的拙见,基线代码看起来干净,优雅并且易于理解。但是当我将代码添加到其中时,代码变得肮脏,丑陋。每个利益相关者都尝试将其请求推送到我们的代码中。当然,我们应该尊重他们。

我们的业务逻辑并不简单。因为它依赖于基线代码的多个版本,运行的项目等等。为了克服增强代码的细节,我们一直使用内联,块注释,错误跟踪系统和Wiki页面。但是关于我们代码的任何事情都是致命的:容易丢失,不方便在服务器中更新文档。最糟糕的是,我很难记住文档在服务器中的位置。

问题:如何记录我们的代码?注释代码的最佳解决方案是什么?

建议: 假设我有ABC.java,并且准备了随附的ABC.java.comment。 在ABC.java.comment文本文件中,存在描述业务逻辑,代码细节,错误修正细节等的文本块。

ABC.java.comment包含

<SHA value> : sha value of ABC.java
<Block #1>
<Block #2>
...
<Block #n>

<Block> has
<line numers>
<text>

谢谢,我想听听您的意见。

0 个答案:

没有答案