我们有一个 Visual Studio 2010 解决方案，其中包含多个符合 Jeffery Palermo 的洋葱架构模式 (http://jeffreypalermo.com/blog/the-onion-architecture-part-1/) 的 C# 项目。我们想使用三斜杠添加 Visual Studio Intellisense 注释，但我们想看看是否有人知道如何采取这种做法的最佳实践。我们是否从核心项目中的模型开始，然后通过基础设施，进入数据访问服务和存储库，进入用户界面？还是以更有限的方式使用这些 cmets 更好，如果是，哪些是应用 Intellisense 注释的重要对象？
【问题讨论】：
标签： c# visual-studio-2010 comments intellisense
将它们添加到公共 API 中公开的任何方法中，这样您就可以在使用外部接口时向调用者提供他们需要的所有信息。例如，该方法可能会抛出哪些异常以及其他备注。
将这些类型的 cmets 添加到私有方法中仍然是有益的，无论如何我都会这样做以保持一致。如果您计划从 cmets 生成文档，这也会有所帮助。
【讨论】：
虽然从技术上讲，文档过多，但在 99.99999% 的情况下，此例外不适用。
尽可能多地记录所有内容。正式的，非正式的，思想流。每一个 cmets 的碎片都会帮助一些继承你的代码或必须与之交互的可怜的灵魂。
（就像旧规则“错误可能出在编译器中，而不是您的代码中。编译器也有错误。这不是其中之一。”）
我们是否从 Core 项目中的模型开始，然后通过基础设施，进入 DataAccess 服务和存储库，再进入用户界面？ 是的
或者以更有限的方式使用这些 cmets 是否更好，如果是这样，哪些是应用 Intellisense 注释的重要对象？ 如果你愿意。将它们应用于您编写的任何函数，而不是 VS 自动生成的函数
我看到了有限的“智能感知”cmets..但随后出现了广泛的代码内 cmets。只要有“内容”，生活就会美好。我通常会在智能感知 cmets 中包含有关每个函数的简短说明，但将大部分“这就是我这样做的原因”放在函数和死树文档中。
【讨论】：
我同意弗莱彻的观点。从面向公众的类和方法开始，然后逐步进入私有代码。如果您是从头开始，为了您自己的方便，我强烈建议您将 XML cmets 添加到所有代码中，但在这种情况下，从公共方法开始，然后在您进入更新它们时更新其他类是一个很好的解决方案。
【讨论】：