你如何确保代码被正确重用?

Nes*_*cio 5 documentation code-reuse communication

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

例子:

  • 实用方法和类
  • 基类
  • 一个接口
  • 一个GUI控件

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

您如何表达您在创建时所做的假设?

你如何确保他们被正确消费?

我对文档,代码图,会议(?)方面的最佳实践和经过验证的技术感兴趣,以确保正确地重用代码.

这个问题非常类似于:寻找可重复使用的代码,但我对更积极主动而不是被动的方法感兴趣.

Jas*_*Cav 3

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

然后,这些库被发布/构建到一个公共位置(我们部署到一个网络服务器),人们可以在那里下载它们并在他们想要的任何项目中使用它们。到目前为止,效果非常好。我们唯一需要注意的是,如果 API 发生变化,我们必须确保每个人都意识到这一点。我们通过版本号和图书馆 wiki 上的信息来做到这一点。

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