我们有一个Visual Studio 2010解决方案，它包含几个与Jeffery Palermo的洋葱体系结构模式（http://jeffreypalermo.com/blog/the-onion-architecture-part-1/）一致的C＃项目。我们希望使用三斜杠添加Visual Studio Intellisense注释，但是我们想知道是否有人知道最佳实践。我们是否从核心项目中的模型开始一路下手，并通过基础架构进入DataAccess服务和存储库并进入用户界面？还是以更有限的方式使用这些评论会更好？如果是的话，将Intellisense评论应用到什么重要对象？使用C＃Intellisense的最佳实践评论
将它们添加到公共API中公开的任何方法中，这样您就可以向调用方提供使用外部接口时所需的所有信息。例如，该方法可能抛出哪些异常和其他说明。
将这些类型的评论添加到私有方法仍然有好处，但我仍然要这样做以保持一致。如果您计划从评论中生成文档，它也会有所帮助。
虽然在技术上存在太多的文档，但99.99999％这个例外不适用。
尽可能多地记录一切。正式的，非正式的思想流......每一条评论都会帮助一些可怜的灵魂继承你的代码或者与之交互。
（这就像旧规则“的错误可能是在编译器，而不是你的代码，编译器显示有问题，这是不是这样的一个时期。”）
难道我们开始一路向下核心项目中的模型，并通过基础架构进入DataAccess服务和存储库以及用户界面？ 是
或者更好地以更有限的方式使用这些评论，如果是的话，应用智能感知评论的重要对象是什么？ 如果你想。把它们应用到你写的任何函数上，而不是VS自动生成的东西
我见过有限的“intellisense”注释..但后面有大量的代码注释。只要“内容”在那里，生活就会很好。我通常在智能感知评论中包含关于每个功能的简短介绍，但是在功能和死树文档中提到了大部分“这就是为什么我这么做”的内容。
我同意弗莱彻。从面向公众的类和方法开始，然后进入私有代码。如果您是从头开始，我强烈建议将XML注释添加到所有代码中以方便您，但在此情况下，从公共方法开始，然后在更新其他类时更新它们是一个很好的解决方案。