C＃源代码中的区域摘要注释是什么？

Question

我知道C＃中的属性是什么，但我不知道那些文本是什么。我从未在任何C＃语言教科书中看到它们。

你能帮我解释一下代码中的文字是什么吗？

他们的目的是什么？我可以安全地删除它们吗？

1. ///
2. #region

Answer 1

#region

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

https://msdn.microsoft.com/en-us/library/9a1ybwek.aspx

/// comments

在Visual C＃中，您可以通过在源代码中直接在注释所引用的代码块之前的特殊注释字段（由三个斜杠表示）中包含XML元素来为您的代码创建文档。

使用/ doc选项进行编译时，编译器将搜索源代码中的所有XML标记并创建XML文档文件。要根据编译器生成的文件创建最终文档，您可以创建自定义工具或使用Sandcastle等工具。

此外，Visual Studio intellisense将使用此信息向消费者显示您的公共API作为描述。就像你有关于输入参数的描述一样，你提到的那个参数的注释将显示给试图在Visual Studio中调用该函数的用户，如下图所示：

Answer 2

/// is for auto-generated documentation

是的，删除是安全的。 Microsoft documentation here

如果您只删除这些标记（而不是中间的代码），则可以安全删除

#region和#endregion

Answer 3

考试xmldocs comments。如果你愿意，你可以安全地删除它们。

区域是文字“帮助者”，可以帮助您specify outlining代码。

Answer 4

是的，只要您删除#region和#endregion标记而不删除之间的代码，就可以安全地删除这两个代码，而不会损坏代码。

区域正如名称所暗示的那样，是执行特定事物的代码区域，例如在许多控制器中，您看到Create，Read，Update和{{ 1}} region，用于定义CRUD操作的代码所在的位置，这也允许您折叠VS中的整个区域以及可能的其他IDE，以便更好地仅查看您想要查看的内容，使导航代码更容易。

三个斜杠Delete用于定义类，属性和方法的XML文档。 VS可以选择在构建中将其输出到XML文档，然后还有其他工具可用于使XML更易于使用。当您将鼠标悬停在VS中的那些类，方法和属性的用法上时，摘要也会显示为工具提示，以便在不阅读代码的情况下更容易理解方法和类的功能。

对于代码来说，这两者都不是很重要，但它们对正在查看代码的开发人员很有帮助，即使编写代码的同一个人在回到几个月前做过的事情时也可以使用XML注释。 / p>