多年来，我一直将 XML 文档内联存储在源代码中，并忍受“绿色海洋”，但最近我发现了 <include file="..." path="..."/>可在 Visual Studio 中使用的指令将文档移至其自己的 XML 文件中。显然，智能感知仍然可以使用此方法工作，SandcaSTLe 等也可以用于生成帮助文件。
我只是想知道其他人如何处理代码被埋在成堆的文档下的“绿色海洋”问题？您是否只是学会接受它，或者是否将 XML 文档移至单独的文件中并在可能需要澄清代码的地方使用内联注释？
优点
- 代码文件变得更加“干净”。
- 它可以更轻松地浏览代码并定位特定的代码块/方法。
缺点
- 如果没有内联文档，可能会让陌生人更难理解代码。
- 缺少文档可能会导致忘记 XML 文件并且在代码更改时不更新文档。
最佳答案
我只是将其内联并使用这些 Visual Studio - Command to collapse all sections of code?当我查看大文件时折叠和展开代码的命令。在这种情况下，我认为弊大于利。除非您和您的开发人员同事非常勤奋地编写文档，否则我认为该方法效果不佳。我见过的大多数代码库中已经缺乏文档，因此在我看来，增加添加文档的难度是一个坏主意。
关于c# - 将 XML 文档内联存储还是存储在单独的文件中？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/13485718/