【问题标题】:Punctuation marks in C# XML comments [closed]C# XML 注释中的标点符号 [关闭]
【发布时间】:2021-01-13 08:55:13
【问题描述】:

我应该在我的 c# xml cmets 中添加标点符号(例如“.”)吗?

在微软官方xml comment documentation 中现在有声明。 您还可以在本文档中看到一些以“。”结尾的 cmets。有些没有。

下面是微软文档的图片。

你知道官方的方法还是得到了一些经验值?

【问题讨论】:

  • 内联 cmets 不同于 XML cmets,后者通常用于生成文档。出于这些目的,需要正确的语法:-)
  • 谢谢。我就是这样看的。但我找不到官方声明。您还可以在 microsoft 文档(也适用于 XML 文档)中看到差异(请参阅我更新的帖子)。

标签: c# coding-style xml-comments


【解决方案1】:

您绝对应该在句子的末尾添加点。在您提供链接的文章中甚至提到了它(在最后的建议中):

文档文本应使用以句号结尾的完整句子。

您的图片上没有点的示例是唯一的示例,这显然是一个错误。所有其他 XML doc cmets 都有一个点。

虽然不是强制性说明,但我前段时间根据我的个人经验写了一份指南,其中包含一些提示: Guidelines to Better XML Doc Comments and Documentation

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2010-10-24
    • 2010-09-24
    • 2014-09-15
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多