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

Question

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

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

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

1. ///
2. #区域

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中调用该函数的用户,如下图所示: