【发布时间】:2008-10-12 00:31:05
【问题描述】:
您在 Intellisense 气泡中看到的类型/成员/参数描述来自哪里?它们是否存储在类型属性中?
编辑:我对内置类型特别感兴趣。
【问题讨论】:
标签: .net visual-studio
您在 Intellisense 气泡中看到的类型/成员/参数描述来自哪里?它们是否存储在类型属性中?
编辑:我对内置类型特别感兴趣。
【问题讨论】:
标签: .net visual-studio
我不知道内置类型,但是当您构建自己的类时,您可以使用 Xml cmets 列出智能感知信息。当您构建项目时,这些 cmets 会放入它们自己的 xml 文件中,只要该文件位于正确的位置,Visual Studio 就可以使用它。不仅如此,您还将获得智能感知帮助来构建 cmets。对于 C#,只需在类、属性或方法正上方的注释行中添加一个额外的 / 字符:///。对于 VB,使用两个额外的 ' 字符:'''
对此有一个警告(我确信在某个地方可以选择控制它),但根据我的经验,一旦您将 xml 注释 anywhere 放在项目中,您就会得到如果您不在项目中任何地方使用它们,则每个未注释的公共项目的编译警告。
【讨论】:
.Net Framework 为随附的程序集提供了一个 XML 文档文件。 IDE 读取这些文档文件以获取内置类型的描述和工具提示。
此文档通常(但不总是)存储在框架 intsall 点的子目录中。例如,在我的机器上,文件存储在目录 C:\windows\microsoft.net\framework\v2.0.50727\en 中。
框架中提供的每个程序集都有一个 XML 文件。
【讨论】:
虽然如果您的类已编译并且您不想发布源代码,那么您可能需要创建一个 XML 模式文件并将其放置在此处。不确定结构,但随便看看,你就会明白我的意思了。
[安装驱动器]\Program Files (x86)\Microsoft Visual Studio 9.0\Xml\Schemas
【讨论】:
我同意 Joel Coehoorn。你可以看看这个主题的 MSDN:http://msdn.microsoft.com/en-us/library/b2s063f7.aspx
还有一篇关于 codeproject 的精彩文章,其中包含大量解释、示例、当您想为您的课程制作文档而不发布完整源代码和您可能使用的所有标准标签的完整列表时的操作方法(您也可以定义自己的标签 - 只需确保使用您的文档工具读取它们,例如 sandcastle)。
codeproject上的文章:http://www.codeproject.com/KB/XML/csharpcodedocumentation.aspx
【讨论】:
还可以查看 DotNetConfig.xsd 文件,该文件通常位于 Visual Studio 8(或 9)安装目录的 Xml\Schemas 子目录中。
【讨论】: