C# XML 注释中的标点符号
Punctuation marks in C# XML comments
我应该在我的 c# xml 评论中添加标点符号(例如“.”)吗?
微软官方xml comment documentation现在有声明。
您还可以在本文档中看到一些以“.”结尾的注释。还有一些没有。
下面是微软文档的图片。
你知道官方的方法还是有一些经验值?
你绝对应该在句子末尾加点。它甚至在您提供 link 的文章中提到(在最后的建议中):
Documentation text should be written using complete sentences ending with full stops.
你的图片上没有点的例子是唯一的,这显然是一个错误。所有其他 XML 文档评论都有一个点。
虽然不是强制性的说明,但我前段时间根据我的个人经验写了一个指南,其中包含一些提示:
Guidelines to Better XML Doc Comments and Documentation
我应该在我的 c# xml 评论中添加标点符号(例如“.”)吗?
微软官方xml comment documentation现在有声明。 您还可以在本文档中看到一些以“.”结尾的注释。还有一些没有。
下面是微软文档的图片。
你知道官方的方法还是有一些经验值?
你绝对应该在句子末尾加点。它甚至在您提供 link 的文章中提到(在最后的建议中):
Documentation text should be written using complete sentences ending with full stops.
你的图片上没有点的例子是唯一的,这显然是一个错误。所有其他 XML 文档评论都有一个点。
虽然不是强制性的说明,但我前段时间根据我的个人经验写了一个指南,其中包含一些提示: Guidelines to Better XML Doc Comments and Documentation