【问题标题】:Documenting public interface of assemblies记录程序集的公共接口
【发布时间】:2013-10-09 01:03:36
【问题描述】:

软件版本控制规则建议在公共 API 发生重大更改时增加 MAJOR VERSION。

我曾尝试在 Visual Studio 和 dotPeek 等应用程序中使用类视图,但到目前为止,我一直无法找到将程序集的所有公共成员列表导出为纯文本或 XML 的方法。有谁知道这样做的好方法吗?

【问题讨论】:

  • 我可以编写一个查询,您可以使用 Reflector 桌面应用程序来执行此操作。您希望输出格式如何?您是否只想在一个列表中按字母顺序列出所有内容?

标签: visual-studio reflection versioning reflector dotpeek


【解决方案1】:

我创建了一个 NuGet 包来执行此操作。 http://www.nuget.org/packages/ApiApprover/

基本上,它将您的公共 API 生成为一个大字符串,然后将其传递给批准测试以进行验证。

如果收到的文本和批准的文本不同,则批准测试会通过未通过测试来工作。如果不同,它会弹出一个合并工具,以便您查看更改并接受它们。批准测试似乎是这个问题的完美解决方案,我只是围绕它包装了公共 API 生成。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2013-09-17
    • 1970-01-01
    • 2017-07-25
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多