如何将XML文档注释添加到Xamarin iOS Bindings Library？

Question

我正在实现Xamarin iOS Bindings Library来绑定Objective-C框架。 如果它甚至可能，我希望它包含XML文档注释。

有没有办法从Objective-C Headers中获取它们，或者至少是以某种方式手动将它们添加到生成的绑定类中？

我尝试将XML注释添加到ApiDefinitions.cs中描述的接口，但obj/Debug/ios/Namespace/*.g.cs中生成的类仍未记录，XML文档文件也保持为空。

Answer 1

您可以使用mdoc生成绑定的XML文档。您可以在https://github.com/mono/monotouch-bindings/blob/master/Rules.make#L7

找到示例

Answer 2

This manual对于生成文档很有用。接下来的步骤已经完成：

1. 将mdoc工具文件夹添加到我从here获取的解决方案中。
2. 将空Mdoc文件夹添加到Bindings项目。它将包含生成的mdoc文档文件。
3. 将以下行添加到Bindings项目的post-build事件中：

$(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文件。这些文件可以包含在项目中（使用Build Action None）并手动填充文档或使用Monodoc browser填充文档。下次重建项目时，将更新文件而不删除已编写的文档。查看mdoc-update了解详情。

第二行将Monodoc XML文件转换为Microsoft XML Documentation文件，该文件可与输出DLL文件一起提供。查看mdoc-export-msxdoc了解详情。