草庐IT

c# - 我可以将 C# 函数标记为 "this function does not enumerate the IEnumerable parameter"吗？

coder 2024-05-25 原文

同一可枚举的多次枚举对我们来说一直是一个性能问题，因此我们尝试在代码中消除这些警告。但是我们有一个通用的扩展函数来抛出空参数异常，它会生成很多这样的警告。它的签名看起来像这样:

public static void VerifyArgumentIsNotNull<T>(this T value, string valueName) where T : class

它所做的只是检查 null 并抛出一个格式良好且本地化(对于当时正在使用的任何人类语言)的异常。

当此函数用于 IEnumerable 参数时，它会使代码分析警告 IEnumerable 可能的多次迭代，因为分析器不知道该函数的作用。

我想在这个函数上加上一些标签，上面写着:“是的，这将可枚举作为输入，但它不会对其进行迭代，因此调用者不应将其视为可能的迭代。”有这样的标签吗？我在互联网上搜索无果。

最佳答案

是的，您的要求很有可能，但需要一些工作。 ReSharper 使用 Code Annotations 向其分析引擎添加提示，并使它必须使用的代码更有意义。我最近用 JetBrains 录制了一个名为 ReSharper Secrets 的网络研讨会，我在其中更详细地介绍了注释是什么以及如何使用它们。你应该看看!

有一个注释属性 [NoEnumeration] 完全按照您的要求进行 - 指定给定的 IEnumerable 参数未被枚举，但它不包含在默认值 Code Annotation Attributes 中，但是它是在 JetBrains.Annotations.dll 程序集中定义的。

所以在这个介绍之后，这是你需要做的:

  1. (如果您还没有，)转到 ReSharper 选项，然后是代码检查 → 代码注释，然后按将默认实现复制到剪贴板按钮
  2. 在您的任何(共享)项目中创建一个名为 Annotations.cs(或任何其他名称)的文件
  3. 从剪贴板粘贴代码，完全替换 Annotations.cs
    4. 中之前的任何内容
  4. 在文件末尾添加以下定义:

代码:

/// <summary>
/// Indicates that IEnumarable, passed as parameter, is not enumerated.
/// </summary>
[AttributeUsage(AttributeTargets.Parameter)]
public sealed class NoEnumerationAttribute : Attribute
{
}

完成此操作后，剩下要做的就是将 [NoEnumeration] 属性放在 value 参数上，如下所示:

public static void VerifyArgumentIsNotNull<T>([NoEnumeration] this T value, string valueName) where T : class
{
    ....
}

就是这样!警告将消失!

奖励:

您可以使用 3 个附加属性来修饰此方法，使其更加有用:[NotNull]、[ContractAnnotation] 和 [InvokerParameterName] 。我最近在 this issue 中描述了他们为名为 LiteGuard 的类似 API 所做的事情(以及一个简短的演示)。

注释很有趣 :)

关于c# - 我可以将 C# 函数标记为 "this function does not enumerate the IEnumerable parameter"吗？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/23546556/

c#codesectionAnnotationsresharperienumerable

有关c# - 我可以将 C# 函数标记为 "this function does not enumerate the IEnumerable parameter"吗？的更多相关文章

  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-on-rails - rails : "missing partial" when calling 'render' in RSpec test - 2

    我正在尝试测试是否存在表单。我是Rails新手。我的new.html.erb_spec.rb文件的内容是:require'spec_helper'describe"messages/new.html.erb"doit"shouldrendertheform"dorender'/messages/new.html.erb'reponse.shouldhave_form_putting_to(@message)with_submit_buttonendendView本身，new.html.erb，有代码:当我运行rspec时，它失败了:1)messages/new.html.erbshou

  3. ruby-on-rails - 由于 "wkhtmltopdf"，PDFKIT 显然无法正常工作 - 2

    我在从html页面生成PDF时遇到问题。我正在使用PDFkit。在安装它的过程中，我注意到我需要wkhtmltopdf。所以我也安装了它。我做了PDFkit的文档所说的一切......现在我在尝试加载PDF时遇到了这个错误。这里是错误:commandfailed:"/usr/local/bin/wkhtmltopdf""--margin-right""0.75in""--page-size""Letter""--margin-top""0.75in""--margin-bottom""0.75in""--encoding""UTF-8""--margin-left""0.75in""-

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

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

  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 - 检查 "command"的输出应该包含 NilClass 的意外崩溃 - 2

    为了将Cucumber用于命令行脚本，我按照提供的说明安装了arubagem。它在我的Gemfile中，我可以验证是否安装了正确的版本并且我已经包含了require'aruba/cucumber'在'features/env.rb'中为了确保它能正常工作，我写了以下场景:@announceScenario:Testingcucumber/arubaGivenablankslateThentheoutputfrom"ls-la"shouldcontain"drw"假设事情应该失败。它确实失败了，但失败的原因是错误的:@announceScenario:Testingcucumber/ar

  7. ruby - 在没有 sass 引擎的情况下使用 sass 颜色函数 - 2

    我想在一个没有Sass引擎的类中使用Sass颜色函数。我已经在项目中使用了sassgem，所以我认为搭载会像以下一样简单:classRectangleincludeSass::Script::FunctionsdefcolorSass::Script::Color.new([0x82,0x39,0x06])enddefrender#hamlengineexecutedwithcontextofself#sothatwithintemlateicouldcall#%stop{offset:'0%',stop:{color:lighten(color)}}endend更新:参见上面的#re

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

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

  9. ruby-on-rails - 迷你测试错误 : "NameError: uninitialized constant" - 2

    我遵循MichaelHartl的“RubyonRails教程:学习Web开发”，并创建了检查用户名和电子邮件长度有效性的测试(名称最多50个字符，电子邮件最多255个字符)。test/helpers/application_helper_test.rb的内容是:require'test_helper'classApplicationHelperTest在运行bundleexecraketest时，所有测试都通过了，但我看到以下消息在最后被标记为错误:ERROR["test_full_title_helper",ApplicationHelperTest,1.820016791]test

  10. ruby-on-rails - 在 ruby​​ 中使用 gsub 函数替换单词 - 2

    我正在尝试用ruby​​中的gsub函数替换字符串中的某些单词，但有时效果很好，在某些情况下会出现此错误？这种格式有什么问题吗NoMethodError(undefinedmethod`gsub!'fornil:NilClass):模型.rbclassTest"replacethisID1",WAY=>"replacethisID2andID3",DELTA=>"replacethisID4"}end另一个模型.rbclassCheck 最佳答案 啊，我找到了!gsub!是一个非常奇怪的方法。首先，它替换了字符串，所以它实际上修改了

随机推荐