在构建xml-comments时是否可以使VS指定类型?

时间:2011-07-29 09:31:54

标签: c# visual-studio-2010 xml-comments post-build-event

我正在尝试为我的代码创建文档,我正在使用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中的T:CaseManager.mainWindow告诉我它是“类型:类,接口,结构,枚举,委托”,其余的告诉我类型的名称空间和名称。无论如何,我要指定它是什么类型。例如,通过编写T:C:...用于类,T:I:...用于接口等等。

1 个答案:

答案 0 :(得分:1)

根据MSDN,至少编译器不会创建其他内容或更具体的内容。

此外,即使您以某种方式设法在XML注释/源代码中指定这些前缀(您可以在某些地方,例如在引用其他内容,例如<see cref="T:SomeType"/>时)编译器,ReSharper,以及什么不会抱怨其他前缀而不是支持的前缀。

最后,如果您愿意,可以自己创建XML文件。但是,这当然不实用,而且应该处理这些XML文件的其他工具(如Sandcastle)很可能无法理解您的约定。

因此,如果没有编写自己的工具集来提取注释并从中提取文档,那么似乎没有办法按照您的要求进行操作。如果这完全可以接受,您可能想要结帐doxygen,但我不知道它在这方面的能力。