在没有XML标记的Visual Studio中获取不同的默认注释文档样式？

Question

我发现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来生成三斜杠？

Answer 1

文档约定取决于文档 generator 。

如果您希望通过评论获得完整的智能感知，或者使用 Sandcastle 等文档生成器，则需要使用XML注释式文档。

另一方面，如果您对支持intellisense不感兴趣并且它是一个内部项目（您不打算开源并与其他开发人员合作），那么您就是＆＃39 ;不要强迫使用 Sandcastle 和XML评论：还有其他选择。例如，请参阅此其他问答：https://softwarerecs.stackexchange.com/questions/39227/net-documentation-generator-alternatives-to-sandcastle

BTW，替代方案的主要问题是他们不支持需要文档的C＃特定项，如泛型参数，lambda表达式和C＃语法的许多其他细节。

我发现了OP

的混乱

在评论聊天之后，我发现OP认为在程序集的元数据中发现的评论是实际文档。他们不是：他们只是常规的评论，而且它不是智力感知的来源。

如果在 Build 类别的项目属性中启用了此构建步骤，则Intellisense将从构建时生成的XML文档文档中获取文档。