.NET // vs ///评论约定

我只是查看F#,如果这是一个愚蠢的问题,请道歉,但在VS2008 F#CTP 1.9.6.2’教程’项目中,//和///都用于评论代码。

两个斜杠与三个斜杠注释之间是否存在function差异,或者是否使用///对函数进行注释(并显示在教程代码中)并使用//用于其他所有内容?

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

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

它与Java中的/* comment */ vs /** documented comment */类似。

后者的工作原理相同,但也被文档软件认可为开发人员文档 – 而不仅仅是注释。

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