在没有XML标记的情况下,在Visual Studio中获得不同的默认注释文档样式
本文关键字:样式 文档 注释 默认 Visual XML 情况下 Studio | 更新日期: 2023-09-27 18:01:39
我发现Unity有一个整洁的代码文档,没有XML标签:
//
// Summary:
// Returns true during the frame the user starts pressing down the key identified
// by the key KeyCode enum parameter.
//
// Parameters:
// key:
我想知道你是否可以设置visual studio来生成这个三重斜杠?
文档约定取决于文档生成器。
如果你想让你的注释完全智能感知,或者使用像Sandcastle这样的文档生成器,你需要使用XML注释风格的文档。
另一方面,如果您对支持智能感知不感兴趣,并且它是一个内部项目(您不打算将其开源并与其他开发人员合作),则不必强制使用Sandcastle和XML注释:还有其他选择。例如,参见以下其他问题:https://softwarerecs.stackexchange.com/questions/39227/net-documentation-generator-alternatives-to-sandcastle顺便说一句,替代方案的主要问题是它们不支持需要文档的c#特定项,如泛型参数、lambda表达式和许多其他c#语法细节。
我发现OP的混乱
在评论上聊天后,我发现OP认为在程序集的元数据中发现的注释是实际文档。它们不是:它们只是常规的注释,它不是智能感知的来源。
Intellisense从从XML注释中提取的构建时生成的XML文档文件中获取文档,如果该构建步骤在 build 类别中的项目属性中启用。