问题标签 [xml-comments]

当我在 Visual Studio 中点击 /// 时，是否可以从此更改生成的代码段：

对此？：

在 C# 的 XML 文档注释中，有没有办法将两个或多个函数标记为彼此重载，以便它们自动相互引用？理想情况下，它们也会以某种方式被分组在沙堡生成的文档中。

目的：通常，我想链接到这组函数，例如在实用函数列表中，只需提及其中一个重载，并让其他重载从那里很容易被发现。

目前我正在添加链接，但这很乏味。

当我在 Visual Studio 中键入触发自动注释功能时（通过键入“'''”或“///”），大多数 XML 注释细节都会显示我喜欢的。但是，我通常将历史标记添加到文档中，以便我可以跟踪和随时间对方法所做的更改。

有什么方法可以自定义自动评论功能，以便添加历史标签，并可能添加一些通用名称 - 日期 - 更改占位符文本？

我的同事在开发我们的软件时很少（如果有的话）使用 XML 注释（我不能说我更好）。我最近看到了使用它们的好处，但是如果它们记录的代码写得很清楚（表达/描述性变量/函数名称，一些内联注释），它们真的值得吗？

谢谢！

在 Visual Studio 和 C# 中，当使用 ToString() 等内置函数时，IntelliSense 会显示一个黄色框来解释它的作用。

对于我编写的函数和属性，我怎样才能拥有它？

我似乎在我的项目的属性页中的“配置属性”文件夹下找不到“构建”选项。我一直在寻找四处试图弄清楚如何做到这一点。

我按照这里的指示：http: //msdn.microsoft.com/en-us/magazine/cc302121.aspx

更具体地说：http: //msdn.microsoft.com/en-us/library/azt1z1eh.aspx （“在 Visual Studio 中构建 XML 文档示例”部分）

我想在构建中为我的项目生成 XML 注释，但我的“配置属性”窗口下没有“文件夹”或“构建”选项。

我正在使用 Visual Studio Team System 2008，有什么想法吗？

编辑 -> 这是一个网站 [无项目]，它是用 C# 和 VB.NET 编写的。

我需要下载任何工具吗？我找到了 GhostDoc，但这对我帮助不大。

在 C# 中，我尝试使用 <see cref="blah"/> 来引用包含 params 关键字的方法签名。我知道这会将参数列表转换为数组，但我什至无法弄清楚如何在 CREF 属性中引用数组。我在搜索中一无所获，我认识的人也没有任何想法。编译器在方括号上窒息。我尝试了各种不同的组合，使用花括号，使用 Array 类，但没有任何效果。有人知道吗？

我一直在尝试使用 XML 注释来完整记录类库的所有类型、方法、属性等，但遇到了涉及cref属性的奇怪效果（see例如，由标签使用）。按照这个 MSDN 页面的建议以及 MSDN 和其他网站上的各种其他示例，似乎每当使用cref标签指定参考值时，它必须以某个标记为前缀，该标记对参考进行分类（例如 ' T:' 表示类型，'M:' 表示方法）。

但是，使用 Microsoft Sandcastle 时，我观察到缺少这些前缀会影响生成的文档（在这种情况下为 CHM 帮助文件）。包括前缀（在我相信的所有情况下），引用在页面上呈现为粗体文本......但不包括前缀，引用被呈现为 API 参考中相应页面的锚（链接）。对我来说似乎很奇怪，推荐的前缀（全部？）引用方法给出的结果最不有用 - 为什么引用在一种情况下呈现为粗体并在另一种情况下链接？如果有人能对此有所了解，我将不胜感激。

我已将警告作为错误打开，现在我需要对我所有的公共方法进行 XML 注释。

只是为了让我的程序编译，我现在只想放置占位符。

无论如何，是否可以自动将 XML 注释添加到类或文件中的所有公共成员。

我看到了 ghost doc，它为您提供了很好的自动生成的 XML 注释，但它看起来仍然一次只处理一个成员。

我想知道是否可以在评论中引用动态泛型类名并在 IDE 中有条件地解决它？

简单的基类示例：

如果我现在从此类继承并且恰好是User类，那么我希望 IntelliSense 将我的评论显示为“从数据库中检索所有用户成员”。

这可能吗？