documentation - 您如何确保正确重用代码？

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题？更新问题，以便 editing this post 可以用事实和引用来回答它.

4年前关闭。




Improve this question




通常，当我们将新功能引入应用程序时，我们可能会产生工件，例如可以在应用程序的其他领域重用的有用方法或类。这些工件不一定记录为功能需求，因为它们通常是我们实现选择的副作用。由于我们经常在团队中开发，因此共享这些代码以防止返工和重复非常重要。

例子:

实用方法和类

基类

一个接口(interface)

一个 GUI 控件

您发现共享这些工件的最有效方式是什么？

你如何传达你在创建它们时所做的假设？

您如何确保正确食用它们？

我对围绕文档、代码图、 session (？)的最佳实践和经过验证的技术感兴趣，以确保正确重用代码。

这个问题非常类似于: Finding Reusable code但我对一种比被动方法更主动的方法感兴趣。

Answer 1

我们的团队在整个开发过程中使用了许多有用的库。这些库以某种“开源”方法保存在一个公共(public)存储库中。每个库(或多个库)都有一个人监督，开发人员可以提交补丁。

然后将库发布/构建到一个公共(public)位置(我们部署到 Web 服务器)，然后人们可以下载它们并在他们想要的任何项目中使用它们。到目前为止，它运作良好。我们唯一需要注意的是，如果有 API 更改，我们必须确保我们确保每个人都意识到这一点。我们通过版本号和我们图书馆维基上的信息来做到这一点。

编辑:此外，我们为我们的库(Javadoc、Crystal Report 等)发布生成的文档，以便开发人员可以使用这些文档。