草庐IT

c# - 我可以将契约(Contract)留在代码中,以便与非代码契约(Contract)开发人员使用的代码库合并吗?

coder 2024-05-25 原文

在过去的几个月里,我一直在为我的公司开发一个副项目,但现在上级决定它非常适合现有产品。

我一直在使用 Microsoft 的 Code Contracts 开发用于静态类型检查的辅助项目(部分原因是我以前没有使用过它们并且渴望学习)。

我的问题是,如果我将我的代码 checkin 到代码库中并使用 Contracts,是否所有其他开发人员都需要安装 Code Contracts 工具才能继续开发?我知道他们都没有安装它,而且我是这里的初级人员,所以我怀疑我能否说服他们所有人都安装它。

我使用的是 .Net 4.5,因此包含了代码契约库,但我想知道 Visual Studio 是否会提示它们没有使用 CONTRACTS_FULL 构建每次构建时都在构建选项中指定,或者,如果我离开 CONTRACTS_FULL在构建选项中,当另一个开发人员尝试构建时会发生什么?此外,我想知道当合约失败时最终产品将如何运行,但代码尚未使用代码合约重写器构建。

我只用一个项目创建了一个新的解决方案。创建了一个触发代码契约违规的简单函数,代码契约被卸载并且 CONTRACTS_FULL未标明。构建并运行它并收到以下错误:

Run-time exception (line 8): An assembly (probably "hdxticim") must be rewritten using the code contracts binary rewriter (CCRewrite) because it is calling Contract.Requires<TException> and the CONTRACTS_FULL symbol is defined.  Remove any explicit definitions of the CONTRACTS_FULL symbol from your project and rebuild.  CCRewrite can be downloaded from http://go.microsoft.com/fwlink/?LinkID=169180. 
After the rewriter is installed, it can be enabled in Visual Studio from the project's Properties page on the Code Contracts pane.  Ensure that "Perform Runtime Contract Checking" is enabled, which will define CONTRACTS_FULL

我认为错误消息需要重写,因为绝对没有指定 CONTRACTS_FULL。

感谢 Matías Fidemraizer,我们发现使用 Contract.Requires<TException>() 时会发生这种情况而不是 Contract.Requires() .

理想情况下,我想修改此行为,以便合约触发提供的异常,就好像它是一个普通的守卫语句而不是提示重写者。

Here's a fiddle演示问题:https://dotnetfiddle.net/cxrAPe

最佳答案

简短的回答是:是的。如果您使用代码契约 checkin 代码,那么所有可能构建该代码的开发人员也必须安装代码契约才能构建代码。

与@CBauer 在他的回答中所写的内容相矛盾的是,代码契约有一个“有福”的包。不,它不是 NuGet 包——它是基于 MSI 安装程序的安装。

最后,如果您在持续集成环境中进行调试构建(例如开发、QA/QC 和/或测试),那么这些构建服务器也需要安装代码契约。

当您使用代码契约时,调试构建总是需要使用代码契约。请注意,Release 版本不一定是这种情况。这取决于您使用的契约(Contract)检查形式以及项目属性中指定的选项。

Code Contracts manual有所有细节。它非常好,我强烈建议您花时间阅读并理解它。

需要注意的是,如果你使用Contract.Requires<TException>(bool condition)作为先决条件的形式,您必须发布 构建启用代码契约(请参阅第 5 节:使用指南,具体来说,第 20 页用法 2 场景)。

由于您要将此代码集成到尚未使用代码契约开发的现有代码库中,因此您应该考虑修改代码契约项目属性设置以符合中概述的使用场景 3 Code Contracts 手册的第 20 页,并使用“遗留”if-then-throw 模式重新制定您的契约(Contract)。这将使您的团队能够最好地将代码库转换为在任何地方都使用代码契约,从而允许您最终用实际的代码契约替换“遗留”if-then-throw 前提条件检查 Contract.Requires(bool condition)检查,如果你愿意,Contract.Requires<TException>(bool condition)检查。

更新:很快就会有一个用于代码契约的 NuGet 包 我今天在 Code Contracts 的新 GitHub 存储库中。对于那些不知道的人,Microsoft 已经开源了它,现在它是一项社区驱动的工作。

他们最近(早在一月份)宣布了 v1.10.xxxx.RC1 版本。您可以找到有关它的信息here on their GitHub repository .

关于c# - 我可以将契约(Contract)留在代码中,以便与非代码契约(Contract)开发人员使用的代码库合并吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/25627419/

有关c# - 我可以将契约(Contract)留在代码中,以便与非代码契约(Contract)开发人员使用的代码库合并吗?的更多相关文章

  1. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  2. ruby - 如何在 buildr 项目中使用 Ruby 代码? - 2

    如何在buildr项目中使用Ruby?我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序,我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/),但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻,因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  3. ruby - 使用 Vim Rails,您可以创建一个新的迁移文件并一次性打开它吗? - 2

    使用带有Rails插件的vim,您可以创建一个迁移文件,然后一次性打开该文件吗?textmate也可以这样吗? 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件,这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails,您可以创建一个新的迁移文件并一次性打开它吗?,我们在StackOverflow上找到一个类似的问题: https://sta

  4. ruby-on-rails - Rails 源代码 : initialize hash in a weird way? - 2

    在rails源中:https://github.com/rails/rails/blob/master/activesupport/lib/active_support/lazy_load_hooks.rb可以看到以下内容@load_hooks=Hash.new{|h,k|h[k]=[]}在IRB中,它只是初始化一个空哈希。和做有什么区别@load_hooks=Hash.new 最佳答案 查看rubydocumentationforHashnew→new_hashclicktotogglesourcenew(obj)→new_has

  5. ruby - 我可以使用 Ruby 从 CSV 中删除列吗? - 2

    查看Ruby的CSV库的文档,我非常确定这是可能且简单的。我只需要使用Ruby删除CSV文件的前三列,但我没有成功运行它。 最佳答案 csv_table=CSV.read(file_path_in,:headers=>true)csv_table.delete("header_name")csv_table.to_csv#=>ThenewCSVinstringformat检查CSV::Table文档:http://ruby-doc.org/stdlib-1.9.2/libdoc/csv/rdoc/CSV/Table.html

  6. ruby - 我可以使用 aws-sdk-ruby 在 AWS S3 上使用事务性文件删除/上传吗? - 2

    我发现ActiveRecord::Base.transaction在复杂方法中非常有效。我想知道是否可以在如下事务中从AWSS3上传/删除文件:S3Object.transactiondo#writeintofiles#raiseanexceptionend引发异常后,每个操作都应在S3上回滚。S3Object这可能吗?? 最佳答案 虽然S3API具有批量删除功能,但它不支持事务,因为每个删除操作都可以独立于其他操作成功/失败。该API不提供任何批量上传功能(通过PUT或POST),因此每个上传操作都是通过一个独立的API调用完成的

  7. ruby-on-rails - 浏览 Ruby 源代码 - 2

    我的主要目标是能够完全理解我正在使用的库/gem。我尝试在Github上从头到尾阅读源代码,但这真的很难。我认为更有趣、更温和的踏脚石就是在使用时阅读每个库/gem方法的源代码。例如,我想知道RubyonRails中的redirect_to方法是如何工作的:如何查找redirect_to方法的源代码?我知道在pry中我可以执行类似show-methodmethod的操作,但我如何才能对Rails框架中的方法执行此操作?您对我如何更好地理解Gem及其API有什么建议吗?仅仅阅读源代码似乎真的很难,尤其是对于框架。谢谢! 最佳答案 Ru

  8. ruby - 有人可以帮助解释类创建的 post_initialize 回调吗 (Sandi Metz) - 2

    我正在阅读SandiMetz的POODR,并且遇到了一个我不太了解的编码原则。这是代码:classBicycleattr_reader:size,:chain,:tire_sizedefinitialize(args={})@size=args[:size]||1@chain=args[:chain]||2@tire_size=args[:tire_size]||3post_initialize(args)endendclassMountainBike此代码将为其各自的属性输出1,2,3,4,5。我不明白的是查找方法。当一辆山地自行车被实例化时,因为它没有自己的initialize方法

  9. ruby - 是否可以覆盖 gemfile 进行本地开发? - 2

    我们的git存储库中目前有一个Gemfile。但是,有一个gem我只在我的环境中本地使用(我的团队不使用它)。为了使用它,我必须将它添加到我们的Gemfile中,但每次我checkout到我们的master/dev主分支时,由于与跟踪的gemfile冲突,我必须删除它。我想要的是类似Gemfile.local的东西,它将继承从Gemfile导入的gems,但也允许在那里导入新的gems以供使用只有我的机器。此文件将在.gitignore中被忽略。这可能吗? 最佳答案 设置BUNDLE_GEMFILE环境变量:BUNDLE_GEMFI

  10. ruby - 模块嵌套代码风格偏好 - 2

    我的假设是moduleAmoduleBendend和moduleA::Bend是一样的。我能够从thisblog找到解决方案,thisSOthread和andthisSOthread.为什么以及什么时候应该更喜欢紧凑语法A::B而不是另一个,因为它显然有一个缺点?我有一种直觉,它可能与性能有关,因为在更多命名空间中查找常量需要更多计算。但是我无法通过对普通类进行基准测试来验证这一点。 最佳答案 这两种写作方法经常被混淆。首先要说的是,据我所知,没有可衡量的性能差异。(在下面的书面示例中不断查找)最明显的区别,可能也是最著名的,是你的

随机推荐