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

Question

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

两个斜杠与三个斜杠注释之间是否存在功能差异，或者是否使用///对函数进行注释以及其他所有内容使用//来实现（如教程代码中所示）？

Answer 1

使用三个斜杠（///）是F＃采用的XML Documentation Comments的C＃约定。

Answer 2

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

Answer 3

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

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

Answer 4

对于C＃和VB.Net，

///或'''不仅仅是内部评论。如果可以在项目属性中启用 XML文档文件，则可以使用Sandcastle和HTML帮助生成四种不同的文档类型（文件和网站）。请参阅https://github.com/EWSoftware/SHFB/wiki和microsoft docs。此外，这可以添加到您的CI流程中。