是否可以为一个#region范围写多行注释？

Question

似乎没有问过这个问题。如果重复，请发表评论。

据说我在C＃代码中有#region条评论。

#region if this comment is very long, can I divide the comment into multi-lines?

   // my code is here

#endregion

是否可以将#region注释分为多行，如底部代码？

#region the comment is separated into
#region-2 two lines.

   // my code is here

#endregion

Answer 1

我不认为长评论是#region指令的预期用法。当我认为“地区”时，我认为像“私人会员”或“服务声明”或“重载的建筑商”之类的东西或者那种性质的简单标签。

如果您有长篇评论，我会将其包含在该区域的顶部，如下所示：

#region Some Region Name

    /**
     * Here is a decently lengthy comment which describes the
     * group of class members within the region.
     */

    /// <summary>
    /// A regular member's comment documentation.
    /// </summary>
    public int MyRegionProperty { get; set; }

    // etc...

#endregion

MSDN将#region后面的部分描述为“名称”，而非评论。名称应该具有描述性，足以识别该地区的内容，仅此而已。

Answer 2

来自MSDN

的#Region的定义

  

`#region允许您指定在使用Visual Studio代码编辑器的大纲功能时可以展开或折叠的代码块。在较长的代码文件中，可以方便地折叠或隐藏一个或多个区域，以便您可以专注于当前正在处理的文件部分。'

其主要目的是允许概述您的代码并能够折叠区域（区域）以便于阅读。如果您想要扩展评论，则必须使用标准C＃评论

Answer 3

Region用于对可以展开和折叠的代码块进行分组，而不是用于评论：

浏览此http://www.dotnetperls.com/region