为什么我看不到外部库的 xml 注释?
我看不到外部库的 xml 注释,这正常吗? 例如,我有一个外部库,其中包含方法的 xml 注释。在引用这个库之后,我希望在使用外部库时能够出现 xml 注释;但工具提示中没有出现任何内容:
也许在构建库时我必须做一些特别的事情。
Is it normal I can't see xml comments from external libraries?
For example I have an external library with xml comments on methods. After making a reference to this library I was hoping that xml comments appears when I make usage of the external library; But nothing appear in the tooltip :
Maybe I have to do something special when I make the build of the lib.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
首先,您需要启用“XML 文件文档”生成。您可以在“项目设置”的“构建”部分下找到它。
然后编译器会生成一个 XML 文件,其中包含构建时的程序集文档。
如果您在另一个项目中引用该程序集,并且希望在 IntelliSense 中查看类型、方法等的文档,则需要将 xml 文档文件存储在存储引用的程序集的同一文件夹中。
First you need to enabled "XML File Documentation" generation. You can find it in the Settings of the Project under the section Build.
Then will the compiler generate an XML File containing your documentation of the assembly on build.
If you reference the assembly in another project and you want to see the documentation of types, methods, etc. in IntelliSense you need to store the xml documentation file in the same folder, where the referenced assembly is stored.