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

本文关键字:约定 注释 vs NET | 更新日期: 2023-09-27 17:47:21

我只是在检查F#,所以如果这是一个愚蠢的问题,很抱歉,但是在VS2008 F# CTP 1.9.6.2"教程"项目中,//和///都用于注释代码。

两个斜杠

与三个斜杠注释之间是否存在功能差异,或者使用///注释函数并将//用于其他所有内容是惯例(如教程代码中所示)?

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

使用三个斜杠 (///) 是 XML 文档注释的 C# 约定,F# 也采用该约定。

///用于文档注释。VS 将在生成智能感知信息时使用它。

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

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

///或 ''' 对于 C# 和 VB.Net 不仅仅是内部注释。 如果在项目属性中打开XML文档文件,则可以使用Sandcastle和HTML帮助生成四种不同的文档类型(文件和网站)。 请参阅 https://github.com/EWSoftware/SHFB/wiki 和 Microsoft 文档。 此外,这可以添加到您的 CI 流程中。