C# 将XML文档内联存储，还是存储在单独的文件中？

多年来，我一直在源代码中内联存储XML文档并忍受“绿色海洋”，但最近我发现了可在Visual Studio中用于将文档移动到其自己的XML文件中的

指令。显然，intellisense仍将使用此方法工作，Sandcastle等也将使用此方法生成帮助文件

我只是想知道其他人是如何处理“绿色海洋”问题的，在这个问题上，代码被埋没在成堆的文档之下？您只是学习如何使用它，还是将XML文档移动到一个单独的文件中，并在可能需要代码澄清的地方使用内联注释

专业人士

• 代码文件变得更加“干净”
• 它使浏览代码和定位特定代码块/方法变得更容易

缺点

• 如果没有内联文档，可能会使陌生人更难理解代码
• 缺少文档可能会导致在代码更改时忘记XML文件而不更新文档的趋势

---

当我查看大文件时，我只是将其保留在内联状态，并使用这些命令来折叠和展开代码。在这种情况下，我认为利大于弊。除非您和您的开发伙伴对文档非常勤奋，否则我认为这种方法不会很好地工作。我所见过的大多数代码库中都已经缺少文档，因此在我看来，增加添加文档的难度是一个坏主意。

我只是让它保持内联状态，在查看大文件时使用这些命令来折叠和扩展代码。在这种情况下，我认为利大于弊。除非您和您的开发伙伴对文档非常勤奋，否则我认为这种方法不会很好地工作。我所见过的大多数代码库中都已经缺少文档，因此在我看来，增加添加文档的难度是一个坏主意。

当这种情况发生在我身上时，我首先要做的事情之一（就像我最近在一家拥有庞大代码库的新公司起步时所做的那样）是运行此处概述的宏：。它切换XML文档的折叠。使用工具使生活更轻松。不要为此付出更大的努力：）当这种情况发生在我身上时，我首先要做的事情之一（就像我最近在一家拥有庞大代码库的新公司创业时所做的那样）是运行此处概述的宏：。它切换XML文档的折叠。使用工具使生活更轻松。不要为此而更加努力：）