问题标签 [xml-comments]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
860 浏览

.net - 如何从 Reflector 查看代码的 XML 注释

我更喜欢使用反射器浏览程序集,即使我有源代码,特别是当我移动到新项目时。但是我觉得如果我能在反射器中看到源代码的 XML 注释会很好。

有没有可以做到这一点的插件?

提前致谢,乌代

0 投票
2 回答
1272 浏览

visual-studio - 是否可以 wikify Visual Studio XML 注释?

是否可以从 Visual Studio 生成的 XML 注释文件生成一组 wiki 页面?

我说的是 Sandcastle 之类的东西,但用于 wiki 格式而不是编译的 CHM。

编辑:我正在使用可以在 XML 中导入/导出文章的 MediaWiki。所以我希望可以编写一个将 XML 注释转换为 MediaWiki XML 的转换。

0 投票
2 回答
1787 浏览

c# - Resources.Designer.cs 中的 XML 注释?

在我的 Visual Studio 2008 项目中,我有一个包含图像和字符串的 Resources.resx 项目。为了强迫自己和其他人至少编写XML 注释,我在项目属性的构建选项卡中启用了 XML 注释的生成。现在,如果有未记录的类、方法……,Visual Studio 会给我一些警告,这太棒了!

但是,自动生成的 Resources.Designer.cs 中的所有图像都没有任何 XML 注释(而字符串有),所以我收到了几个关于缺少 XML 注释的编译器警告,我实际上无能为力,因为对它的更改无论如何,文件可能会被覆盖。

有没有机会

  • 告诉编译器忽略设计器生成的代码中的 XML 注释,或者
  • 强制 Visual Studio 2008 将资源注释写入生成的代码?

感谢您的任何提示!

0 投票
4 回答
2122 浏览

vb.net - Visual Studio 2008 是否可以在没有选中“生成 XML 文档文件”的情况下自动创建 XML 注释标签(仅限 VB.NET)?

在 VS 2008 中,如果开发人员点击“”,它会为您生成 XML 注释标签,但这仅在选中“生成 XML 文档文件”的项目设置时才有效。

不管项目设置如何,有没有办法告诉 VS 生成 XML 注释标签?

我认为有人可能想要评论但不创建 XML 文档文件。

在这种情况下,我超出了当前的团队设置,但其他开发人员不希望我更改此项目设置。这迫使我在签入项目之前将其翻转过来。

我对“代码分析”等其他项目设置也有同样的问题。

这只是 VB.NET 项目的问题。

0 投票
1 回答
634 浏览

.net - .NET 源代码 XML 注释如何保留在程序集元数据中?

您是否注意到对于系统程序集中的某些方法,.NET Reflector 也显示了相应的文档?这意味着文档可以保存在程序集元数据中。

我怎样才能使它适用于我自己的程序集?意思是,当我在 .NET 反射器中反映我的方法时,我想看到我对方法的评论。

谢谢。

0 投票
1 回答
3145 浏览

.net - 如何自动将 XML 源注释导出到文本文档?

我一直在使用 XML 注释在 VB.Net 中记录我的源代码(当我开始使用 C# 时)。我似乎记得很久以前有人告诉我,有一种方法可以自动将 XML 注释导出为文本文档或其他格式,以便在 Visual Studio 之外轻松引用。在那儿?它是什么,或者它们是什么?

0 投票
3 回答
3424 浏览

visual-studio - 如何折叠 Visual Studio 2008 中的所有 XML 注释

我想知道是否有一个插件、插件或任何其他简单的方法来摆脱 C# 臃肿的 xml 注释?

公司需要文档,但在我的日常工作中,这些评论只是在污染代码。如果有一种简单的方法可以将方法之前的所有 xml 文档简单地折叠到一行,甚至更好地没有 :-)

有人有什么想法吗?

TIA

0 投票
2 回答
3891 浏览

vb.net - XML 注释不在 IntelliSense 中显示

我正在尝试让 VB.NET XML Comments 与IntelliSense一起使用,也许它不像我认为的那样工作。

这应该,当您输入一个函数时,显示“获取或设置患者代码”,然后在其下方,它应该显示一个带有“验证:”作为标题的项目符号列表?

替代文字 http://www.codejames.com/errored.jpg

也许我做错了,但它似乎没有正常工作。

0 投票
2 回答
1280 浏览

c# - 如何自动更正方法的 xml 文档

在以下 xml 文档中的代码中,方法参数中的参数名称与 xml 文档中的参数名称不匹配。有没有办法自动更正 xml 文档签名或 resharper 中提供的任何功能来自动更正 xml 文档。

例如,我想要这样的带有 xml 文档的方法:

0 投票
1 回答
1077 浏览

c# - XML 注释支持哪些字符实体?

在下面的例子中,&andΔ是 OK 但Δ不是(后两个都是 Δ)。编译器发出类似于以下内容的警告:

XML 注释支持哪些字符实体?