向 C# 命名空间添加描述答案

【问题标题】：Adding a description to C# namespace向 C# 命名空间添加描述
【发布时间】：2019-10-11 21:20:24
【问题描述】：

我正在开发一个项目，并希望提供一些关于特定命名空间上下文的见解（例如，这是由插件实现的 API 包，这是由应用程序提供给插件的 API 包，这是在应用程序之间传递对象的中间层和插件）。 java里面有package-info.java，C#有类似的概念吗？

【问题讨论】：

添加摘要不起作用吗？你知道，当你连续输入 3 个斜杠时“///”
C# 和 Java 之间的一个主要区别是语言元素和封装之间的关系。您没有用package-info.java 注释 namespace，而是在注释包（并且，在 Java 中，存在一对一的关系（据我记得 - 已经有一段时间了） . 在 C# 中，命名空间可以跨越程序集（并且，一个类可以跨越文件）。查看 AssemblyInfo.cs 文件（在传统框架项目上）和@TerryTyson 正在谈论的/// XML cmets 中的属性关于。
@Flydog57 AssemblyInfo.cs 看起来很像。如果我是你，我会添加这个作为答案。
您可能已经注意到，您不能将/// XML cmets 添加到命名空间。我打算回答你的问题（如你所建议的那样），但在进行研究时，我发现 stackoverflow.com/questions/23144872/… 完全回答了它。

【解决方案1】：

/// 后跟摘要标签可能是将 cmets 添加到命名空间的最佳和最有效的方式。

namespace Content101 {
  /// <summary>
  /// Interaction logic for MainWindow.xaml
  /// </summary>


}

【讨论】：

XML 注释去 Above 他们附加到的元素，而不是下面。如果您使用/// XML 注释注释命名空间指令（通过将注释放在namespace 上方，您将获得CS1587: XML comment is not placed on a valid language element