问题标签 [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 投票
3 回答
2647 浏览

visual-studio - vb.net - 自动 XML 注释 - ''' -- 我可以更改自动默认值吗?

我正在使用 Visual Studio 2008 SP1

在 VB.NET 中,当我在函数上方键入 ''' 时,会出现一些自动默认的 XML 注释:

我希望改为以下内容:

当您在函数上方键入“”时,有没有办法更改出现的内容?

0 投票
2 回答
1245 浏览

php - XSLT / Xpath:选择前面的注释

我有以下格式的 XML,我想重新格式化:

我的问题是我不知道如何选择每个块标签上方的评论。我有以下 XSL:

我正在尝试的输出是:

=== 苹果 ===
block1
=== 香蕉 ===
block2
=== 橙子 ===
block3

但我能得到的最好的是:

=== 苹果 ===
=== 香蕉 ===
=== 橙子 ===
block1
=== 苹果 ===
=== 香蕉 ===
=== 橙子 ===
block2
=== 苹果 == =
=== 香蕉 ===
=== 橙子 ===
block3

如果这有什么不同,我正在使用 PHP。

0 投票
5 回答
17076 浏览

c# - C# XML /// 注释,在哪里标签出现?

我目前是一名编程学生,显然我的问题很简单,但我一直无法在网上找到答案。所以这里是:

在 C# 中的 XML /// 注释中,<returns>标记出现在哪里,我知道<summary>当您将鼠标悬停在方法调用上时,标记中包含的所有内容都会以智能感知显示,而不是返回标记。

那么<returns>标签是从哪里来的呢?

谢谢。

0 投票
9 回答
2424 浏览

c# - 代码注释:您是否将代码注释放在接口或具体类上,或两者兼而有之?

记录类和接口的最佳实践是什么。假设您有一个名为 Foo 的具体类,它派生自一个名为 IFoo 的接口。你在哪里对你的方法发表评论?您是否重复您对接口和具体类的评论?

这是一个重复注释的示例:

0 投票
3 回答
4487 浏览

c# - ConfigurationManager 能否保留 Save() 上的 XML 注释?

我编写了一个小实用程序,允许我为另一个应用程序的 App.config 文件更改一个简单的 AppSetting,然后保存更改:

这很好用,除了一个副作用。新保存的 .config 文件丢失了所有原始 XML 注释,但仅在 AppSettings 区域内。是否可以保留原始配置文件 AppSettings 区域中的 XML 注释?

如果您想快速编译和运行它,这里是完整源代码的 pastebin。

0 投票
1 回答
446 浏览

visual-studio - 如何转义 XML 注释中的关键字,如“note”?

如何在 Visual Studio 中转义 XML 注释中的关键字,如“note”?

例如

我不希望“note”后面的文字变成蓝色。

请注意,这可能是 Resharper 功能。

0 投票
1 回答
226 浏览

visual-studio-2008 - 如何使 VS 2008 中的 Xml 注释与 Intellisense 一起用于枚举?

似乎并非所有 Xml 注释都显示在 Intellisense 中,但也许我做得不对?无论如何,我正在努力使枚举列表中的各个枚举成员以智能感知方式显示并带有描述性文本。例如,在 String.Split 方法中,第三个重载将 StringSplitOptions 枚举作为参数,如下所示:

替代文字 http://www.freeimagehosting.net/uploads/a138d36615.jpg

在我尝试过的其他事情中:

上面的示例确实有效,但仅适用于第一个枚举,而不适用于其他任何枚举。

我做错了什么?

0 投票
1 回答
669 浏览

c# - 动态获取方法/参数 xml 注释

所以您知道如何定义方法注释,例如

有什么方法可以在代码中检索它。我的意思不是解析 .cs 文件,而是实际获取它以便我可以使用它。就像是

提前致谢!

0 投票
2 回答
303 浏览

templates - 使用 T4 模板复制评论

我正在使用 T4 模板从接口生成一个类,并且我希望能够将 xml 注释从接口复制到类方法。有可能吗?如果可以,怎么做?

在我的模板中,我只是采用接口方法并像这样复制它们:

0 投票
1 回答
29 浏览

comments - 为每个类成员写一个类的成员类型有什么意义吗?

在这样的代码中写注释有什么意义吗?

在 Visual Studio 中,智能感知对每种类型的类成员(字段、属性等)都有图标,所以我不明白这一点。在我目前的商店中,无论如何我们只使用 Visual Studio,它提供了这些图标。

谢谢