.Net库样式评论

Question

.NET Framework建议＆＃34; ///＆＃34;用于代码中的文档。但是，当我看到.NET库时，我发现他们正在使用以＆＃34; //＆＃34;开头的正常注释。此外，我看到由于API看起来干净。见下面的截图：

请注意，折叠框仅显示省略号（＆＃34; ...＆＃34;），并放在方法声明的前面。但是当我尝试遵循同样的原则时，我没有得到理想的结果。见下面的截图：

请注意我得到＆＃34; //＆＃34;字符和省略号（＆＃34; ...＆＃34;）。另外，我无法将字段/方法和注释放在同一行。

我如何获得相同的结果？我在这里缺少什么诀窍？

Answer 1

  

然而，当我看到.NET库

时

您没有查看实际的源代码。这仅仅是Visual Studio为您生成的元数据的表示。看起来有些文档是从某个地方引入的（这并没有像我刚试过的那样在我的盒子上发生，但那是另一回事）。你可以告诉我这不是真正的源代码，因为声明的构造函数没有正文。

如果您查看正版源代码，例如ReferenceSource for TcpClient您会看到三重斜线评论。有趣的是，.NET Core code也没有任何XML注释，但我怀疑，因为它们已在其他地方定义，作为.NET Standard的一部分。 （dotnet-api-docs回购中有XML file，但是不能立即清楚从生成 ...）< / p>

对于您自己的代码，我强烈建议您只使用///语法。 /** ... */也可以正常运行，但我不记得曾经在C＃代码中看到过这种情况。 // 不是在C＃中编写XML注释的有效方式。