2

多年来，我一直在我的源代码中内联存储 XML 文档并忍受“绿色海洋”，但我最近发现了<include file="..." path="..."/>可以在 Visual Studio 中用于将文档移动到它自己的 XML 文件中的指令。显然智能感知仍然可以使用这种方法，Sandcastle 等用于帮助文件生成。

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

优点

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

缺点

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

http://msdn.microsoft.com/en-us/library/9h8dy30z.aspx

4

1 回答 1

4

我只是将它内联并使用这些Visual Studio - 命令折叠所有代码部分？查看大文件时折叠和展开代码的命令。在这种情况下，我认为利大于弊。除非您和您的开发人员对文档非常勤奋，否则我认为该方法效果不佳。我见过的大多数代码库中已经缺少文档，因此在我看来，增加添加它的难度是一个坏主意。

于 2012-11-21T03:24:58.353 回答