如何确保代码被正确重用? [关闭]

2024-06-20

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

例子:

  • 实用方法和类
  • 基类
  • 一个接口
  • 图形用户界面控件

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

您如何传达创建它们时所做的假设?

如何确保它们被正确食用?

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

这个问题非常类似于:寻找可重用的代码 https://stackoverflow.com/questions/869364/finding-reusable-code但我对一种比被动的方法更主动的方法感兴趣。


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

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

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

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何确保代码被正确重用? [关闭] 的相关文章

  • 如何在 YARD 中记录具有可变数量参数的函数?

    我有一个接受可变数量参数的函数 如下所示 def myfun args end 所有参数都具有相同类型 Symbol 所以现在我记录该函数 就像只有一个参数一样 说它可以接受多个参数 例如 this function doesn t do
  • 如何记录 Delphi 中引发的异常? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我经常调用一个函数Foo并想知道这个函数可能会抛出什么异常 为了找出答案 我然后研究了实施Foo 但这还不够 Foo确实可能调用一个函数Bar这
  • 有没有办法在 protobuf (proto2) 中创建类型别名?

    是否可以创建 protobuf 标量类型的别名 例如 我想使用Sequence替代string 即使它们是二进制等价的 我的近期目标是使文档 使用 protoc gen doc 生成 更容易理解 理想情况下 这种类型应该用支持类型检查的语言
  • 两个 WPF 应用程序之间的通信

    我有两个 WPF 应用程序 我需要这两个应用程序能够相互通信 我只需要这些应用程序相互发送一些通知 仅此而已 我已经找到了两种技术 一种是使用WCF 另一种是使用DDE 但对我来说 这些对于我的要求来说似乎太复杂了 请建议最简单的方法是什么
  • 两部手机之间无法发送GSM数据吗?

    请详细告诉我为什么两部手机之间无法通过GSM传送数据 我几乎找不到关于这个问题的信息 这里有2点 首先 GSM 是一种移动语音电话系统 普通 GSM 不进行数据连接 GPRS 和 EDGE 是 GSM 网络的附加组件 允许发送数据 还有其他
  • 在哪里记录 C 或 C++ 中的函数? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我有一个包含多个文件的 C 程序 所以我有 例如 stuff c它实现了一些功能 并且stuff h与函数原型 我应该如何在注释中记录功能 我应
  • 离线、跨选项卡通信(仅限 JavaScript)

    是否可以找到某些网站的国外实例 Ofc 这些是独立打开的选项卡 不是通过 window open 我需要阻止用户打开 2 个选项卡 并向之前打开的选项卡发送消息以告知无法打开 2 个选项卡 2个独立的选项卡可能会破坏页面离线存储和webSQ
  • 如何用UML表示通信协议?

    在我的 UML 模型中 我有一个系统及其相互通信的子组件 例如 我有一台计算机和一个遥控机器人 它们通过蓝牙进行通信 目前图中的流程类似于 计算机 触发 遥控车 的 setVelocity 函数 在这一点上 我想通过说以下的话来完善沟通 计
  • 如何组织大型代码文件?

    我越来越意识到 任何单个文件中的代码通常可以很容易地跨越数百行 尽管我知道实现可能是合理的 但它仍然感觉混乱和无组织 我知道在某些情况下需要大量代码 但是组织所有代码的最佳方法是什么 我考虑过将变量与方法分开 privates from p
  • 有已知网络爬虫的列表吗? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在尝试获取网络服务器上某些文件的准确下载数量 我查看了用户代理 其中一些显然是机器人或网络爬虫 但
  • .NET 有成功的 profibus 通信吗?

    有没有人聊成功了profibus http www profibus com 来自 NET 应用程序 如果您这样做了 您使用什么设备 卡来完成此操作 应用程序是什么 以及您是否使用任何类型的预先存在或可用的代码 我们没有使用过Profibu
  • python 文档字符串中的这些标签 @ivar @param 和 @type 是什么?

    ampoule 项目在文档字符串中使用一些标签 例如 javadoc 标签 例如来自pool py http bazaar launchpad net dialtone ampoule main annotate 26 file id po
  • VS2012如何通过IntelliSense显示标准C++库的文档?

    几天前 我开始使用 Visual Studio 2012 学习 C 我习惯于使用 IntelliJ IDEA 进行 Java 编程 并且在调用方法时总是会显示文档和预期参数 有没有办法在 VS2012 中为 C 执行此操作 如果我理解正确的
  • 如何使用C#与Chrome(Chrome扩展)通信?

    我想创建一个可以在我的 C 应用程序和扩展之间进行通信的桥梁 这是我真正想要的解释 我创建了一个扩展 它将获取 HTML 元素的详细信息 但每次启动 Chrome 时都会启动 除了这样做之外 有什么方法可以向我的 chrome 扩展发送消息
  • 为开发人员记录访问应用程序[关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我需要记录一个完全由高级用户创建 开发和维护超过 10 年的 MS Access 应用程序 这是一个有趣的情况 因为他们想要的是一本手册 以便未
  • 如何记录函数的全局依赖关系?

    我从第三方供应商 用于嵌入式平台 获得了一些使用全局变量 用于速度和空间优化 的 C 代码 我正在记录代码 转换为Doxygen格式 如何在函数文档中添加函数需要的全局变量和函数的注释 Doxygen有用于注释参数和返回值的特殊命令 如下所
  • 添加和完成 PHP 源代码文档的工具 [关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我有几个已完成的较旧的 PHP 项目 其中有很多内容 我想以 javadoc phpDocumentor
  • 使用 Sandcastles 将图像嵌入 CHM 帮助文件

    我正在使用 Sandcastles 为我的项目生成 CHM 帮助文件 我想要一个可以分发的独立 CHM 文件 最好是单独分发 我遇到的问题是嵌入图像appears该图像需要与 CHM 文件分开存在于用户系统上 当我查看 CHM 文件的来源时
  • 将自动生成的 Matlab 文档导出为 html

    我想为我开发的 Matlab 工具箱生成完整的帮助 我已经看到如何显示自定义文档 http www mathworks fr fr help matlab matlab prog display custom documentation h
  • Doxygen:空详细说明

    Context 用于生成 RTF 文档的 C 代码的 Doxygen 工具 在模块 组的文档中 即使没有为某些特定模块 组提供详细描述 我们也会获得标题 详细描述 在生成的 RTF 文档中 这看起来很难看 是否可以去掉这个空的详细描述部分

随机推荐