如何使用 XML 文档文件

发布于 2024-07-14 22:30:44 字数 185 浏览 9 评论 0原文

  1. 当使用带有 XML 文档文件的外部程序集时,如何让 Visual Studio 找到它?

    当使用带有 XML
  2. 当有 XML 文档文件时,是否有程序或 xml 转换文件或其他东西可以让我以良好的方式查看它? 不一定像 msdn 文档查看器那样复杂,但至少比纯 xml 更好...

  1. When using an external assembly which comes with an XML documentation file, how do I get visual studio to find it?

  2. When having an XML documentation file, is there a program or xml transform file or something I can use to look at it in a nice way? Not necessarily as complex as the msdn documentation viewer thingy, but at least something nicer than the pure xml...

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(4

娇妻 2024-07-21 22:30:44

1:您只需将其放在与 dll 相同的文件夹中

2:它需要保留吗? 对于“实时”使用,VS IDE 和“reflector”都允许您查看文档(针对类型/成员/等)。 有一些工具可以改变它,但我从来没有打扰过。 Sandcastle 可能值得一看,但对我来说从来都不好;-p

1: you simply drop it in the same folder as the dll

2: does it need to be persisted? For "live" use, both the VS IDE and "reflector" allow you to review the documentation (against the types/members/etc). There are tools to transform it, but I've never bothered. Sandcastle may be worth a look, but it was never nice to me ;-p

风追烟花雨 2024-07-21 22:30:44

关于 2:您应该能够使用对象浏览器(“视图”>“对象浏览器”(Ctrl W + J))查看文档的“漂亮版本”,然后浏览到要查看文档的类。 我使用对象浏览器来查看我自己的文档,因为它比 xml 文件或注释对读者更友好。

Regarding 2: You should be able to look at a "pretty version" of the documentation using the Object browser (View > Object Browser (Ctrl W + J)) and then browse your way to the class for which to review the documentation. I used the Object Browser to review my own documenation since it is more reader friendly than the xml files or the comments.

亢潮 2024-07-21 22:30:44

回答你的第一个问题:xml 应该与程序集具有相同的名称,并且位于它的旁边。 因此,如果您有一个名为 Svish.dll 的程序集,那么您的文档文件应该是 Svish.xml 并且位于同一目录中。

Answer to your first question: the xml should have the same name as the assembly and be right next to it. So if you have an assembly called Svish.dll then your documentation file should be Svish.xml and be in the same directory.

孤独难免 2024-07-21 22:30:44

1) 文档文件必须与程序集同名,并添加扩展名“.xml”,并且与其相应的程序集位于同一目录中。 例如,同一目录中有一个“MyCompany.MyNamespace.dll”和一个“MyCompany.MyNamespace.dll.xml”文件。

2) NDOC 可以生成一些不同格式的文档。

1) The documentation file must have the same name as the assembly name, with the added extension '.xml', and reside in the same directory as its corresponding assembly. So for example, you have an 'MyCompany.MyNamespace.dll' and a 'MyCompany.MyNamespace.dll.xml' file in the same directory.

2) NDOC can generate some dirrent formats of documentation.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文