c# - 在构建 xml-comments 时是否可以让 VS 指定类型？

Question

我正在尝试为我的代码创建文档，并且我正在使用 xml-comments。当一个类被记录如下：

/// <summary>
/// Main presentation window
/// </summary>
public partial class mainWindow : Form
{
}

xml 文件将包含 mainWindow 的以下条目：

<member name="T:CaseManager.mainWindow">
        <summary>
        Main presentation window
        </summary>
    </member>

T:CaseManager.mainWindow 中的 T 告诉我它是“类型：类、接口、结构、枚举、委托”，其余的告诉我类型的名称空间和名称。无论如何让我指定它是哪种类型。例如，为类编写 T:C:...，为接口编写 T:I:... 等等。

score 1 · Accepted Answer

根据MSDN，至少编译器不会创建其他或更具体的东西。

此外，即使您以某种方式设法在您的 XML 注释/源代码中指定这些前缀（您可以在某些地方，例如在引用其他内容时，<see cref="T:SomeType"/>如.

最后，您可以根据需要自行创建 XML 文件。然而，这当然是不切实际的，而且像Sandcastle这样应该处理这些 XML 文件的其他工具很可能无法理解您的约定。

因此，除了编写您自己的工具集来提取评论并从中生成文档之外，似乎没有一种方法可以满足您的要求。如果这完全可以接受，您可能想检查doxygen，但是我不知道它在这方面的能力。

1 回答 1