是否可以让 VS 在构建 xml 注释时指定类型?

发布于 2024-11-27 05:11:11 字数 531 浏览 2 评论 0原文

我正在尝试为我的代码创建文档,并为其使用 xml 注释。当一个类的记录如下:

/// <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:... 等等。

I'm trying to create documentation for my code and I'm using xml-comments for it. When a class is documented like the following:

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

The xml file will contain the following entry for mainWindow:

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

The T in T:CaseManager.mainWindow tells me it is "type: class, interface, struct, enum, delegate" and the rest tells me the namespace and name of the type. Is there anyway to make i specify what kind of type it is. For example by writing T:C:... for class, T:I:... for interface and so on.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

深海夜未眠 2024-12-04 05:11:13

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

另外,即使您以某种方式设法在 XML 注释/源代码中指定这些前缀(您可以在某些地方,例如引用其他内容时,例如 ) 编译器、ReSharper 等都会抱怨支持的前缀之外的其他前缀。

最后,如果您愿意,您可以自行创建 XML 文件。然而,这当然是不切实际的,而且其他工具,如 Sandcastle,应该处理这些 XML 文件,将很可能不理解您的惯例。

因此,如果没有编写自己的工具集来提取注释并从中生成文档,似乎没有办法完成您所要求的操作。如果这是可以接受的,您可能需要查看 doxygen,但我不知道它是什么有这方面的能力。

According to MSDN, at least the compiler does not create something else or more specific.

Also, even if you somehow manage to specify those prefixes in your XML comments / source code (you can at some places, for example when referencing other stuff like <see cref="T:SomeType"/>) the compiler, ReSharper, and what not will complain about other prefixes than the supported ones.

Finally, you could create the XML file all on your own if you like. However, that is of course not practical and also other Tools like Sandcastle, that should process these XML files, will most likely not understand your convention.

So, short of writing your own toolset to extract comments and produce documentation from it, there doesn't seem to be a way to do what you ask. If that is at all acceptable, you might want to checkout doxygen, however I don't know what it is capable of in this regard.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文