【问题标题】:.Net Library style Comments.Net 库风格 评论
【发布时间】:2018-09-22 17:27:53
【问题描述】:

.NET Framework 建议使用“///”作为代码文档。但是,当我看到 .NET 库时,我看到他们使用以“//”开头的普通注释。另外,我看到由于 API 看起来很干净。看下面的截图:

请注意,折叠框仅显示省略号(“...”),并放置在方法声明的前面。但是当我尝试遵循相同的方法时,我没有得到想要的结果。看下面的截图:

请注意,我得到“//”字符和省略号(“...”)。另外,我无法将字段/方法和评论放在同一行。

如何获得相同的结果?我在这里缺少什么技巧吗?

【问题讨论】:

    标签: c# .net comments


    【解决方案1】:

    但是,当我看到 .NET 库时

    您没有查看实际的源代码。这只是 Visual Studio 为您生成的元数据的表示形式。看起来有些文档是从某个地方拉进来的(我的盒子上没有发生这种情况,就像我刚刚尝试过的那样,但那是另一回事)。你可以看出这不是真正的源代码,因为声明的构造函数没有正文。

    如果您查看真正的源代码,例如ReferenceSource for TcpClient 你会看到三斜线 cmets。有趣的是,.NET Core code 也没有任何 XML cmets,但我怀疑这是因为它们是在其他地方定义的,作为 .NET Standard 的一部分。 (dotnet-api-docs 存储库中有一个 XML file,但目前尚不清楚它是由什么生成的...)

    当涉及到您自己的代码时,我强烈建议您只使用/// 语法。 /** ... */ 应该也可以,但我不记得在 C# 代码中看到过。 // 不是在 C# 中编写 XML 注释的有效方式。

    【讨论】:

    • 感谢您的回复。我知道我正在查看的不是实际代码,但我喜欢它在 Visual Studio 中的表示方式。我也尝试过使用“///”作为文档,但折叠后结果也不是那么好。大多数情况下,我最终在滚动代码时一次又一次地折叠它们。看起来更杂乱,难以专注于代码。 (恕我直言)
    • @Himanshu1983:恐怕你真的不清楚你在问什么,但我认为你需要接受你不能使用// 来生成 XML 文档。如果这真的只是“我不喜欢 Visual Studio 折叠 cmets 的方式”,那么这不是一个我们可以在 Stack Overflow 上回答的问题。
    • 我的问题是是否有可能获得类似的行为。我已经在使用文档标签,但是当我去那个类元数据时我没有看到。所以,我认为我在那里遗漏了一些东西。无论如何,谢谢你的时间。让我们看看我们是否对此有任何有趣的见解。
    猜你喜欢
    • 1970-01-01
    • 2014-07-01
    • 1970-01-01
    • 1970-01-01
    • 2015-09-02
    • 2021-06-10
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多