如何将 XML 文档注释添加到 Xamarin iOS 绑定库？答案

【问题标题】：How to add XML documentation comments to Xamarin iOS Bindings Library?如何将 XML 文档注释添加到 Xamarin iOS 绑定库？
【发布时间】：2017-04-19 11:11:56
【问题描述】：

我正在实现 Xamarin iOS 绑定库来绑定一个 Objective-C 框架。如果可能的话，我希望它包含 XML 文档 cmets。

有什么方法可以从 Objective-C 标头中获取它们，或者至少以某种方式手动将它们添加到生成的绑定类中？

我尝试将 XML cmets 添加到 ApiDefinitions.cs 中描述的接口，但 obj/Debug/ios/Namespace/*.g.cs 中生成的类仍然没有记录，XML 文档文件也仍然是空的。

【问题讨论】：

标签： xamarin xamarin.ios xml-documentation xml-comments

【解决方案1】：

您可以使用mdoc 为绑定生成 XML 文档。你可以在这里找到一个例子https://github.com/mono/monotouch-bindings/blob/master/Rules.make#L7

【讨论】：

【解决方案2】：

This manual 对生成文档很有用。接下来的步骤就完成了：

将一个 mdoc 工具文件夹添加到我从 here 获取的解决方案中。
将一个空的 Mdoc 文件夹添加到 Bindings 项目。它将包含生成的 mdoc 文档文件。
将以下行添加到 Bindings 项目的构建后事件：

$(SolutionDir)tools\mdoc\mdoc update -L "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\Xamarin.iOS\v1.0" --out $(ProjectDir)Mdoc $(TargetPath)
$(SolutionDir)tools\mdoc\mdoc export-msxdoc $(ProjectDir)Mdoc

第一行生成或更新 Mdoc 文件夹中的一堆 XML 文件。这些文件可以包含到项目中（使用无构建操作）并手动填写您的文档或使用Monodoc browser。下次重建项目时，将更新文件而不删除已经编写的文档。详情请查看mdoc-update。

第二行将 Monodoc XML 文件转换为可与输出 DLL 文件一起提供的 Microsoft XML 文档文件。详情请查看mdoc-export-msxdoc。

【讨论】：

嗨，Olexander，你在第一行提到的发布图片事件的路径是什么。
@raheem52，来自mdoc-update "-L, --lib=DIRECTORY - 将 DIRECTORY 添加到程序集搜索路径，以便无需记录这些程序集就可以找到 ASSEMBLIES 的依赖项。" - 在这种情况下，这是 Xamarin.iOS 参考库路径。