.NET // vs /// 注释约定

Posted 2023-02-21

【中文标题】.NET // vs /// 注释约定

【英文标题】：.NET // vs /// Comments convention

【发布时间】：2010-09-15 21:53:04

【问题描述】：

我只是检查 F#，如果这是一个愚蠢的问题，请道歉，但在 VS2008 F# CTP 1.9.6.2 'Tutorial' 项目中， // 和 /// 都用于注释代码。

两个斜线与三个斜线注释之间是否存在功能差异，或者是惯例（如教程代码中所示）用 /// 注释函数并使用 // 其他所有内容？

【参考方案1】：

使用三个斜杠 (///) 是 XML Documentation Comments 的 C# 约定，也被 F# 采用。

【参考方案2】：

/// C# 和 VB.Net 的 ''' 不仅仅是内部 cmets。如果在项目属性中打开 XML 文档文件，则可以使用 Sandcastle 和 html Help 生成四种不同的文档类型（文件和网站）。请参阅 https://github.com/EWSoftware/SHFB/wiki 和 microsoft docs。此外，这可以添加到您的 CI 流程中。

【参考方案3】：

类似于 Java 中的 /* comment */ 与 /** documented comment */。

后者的工作原理相同，但也被文档软件识别为开发人员文档 - 而不仅仅是注释。

【讨论】：

只有知道这些注释结构在 Java 中的作用时才会有帮助，这不是问题所在。

【参考方案4】：

/// 用于文档 cmets。 VS 在生成智能感知信息时会用到它。