如何将文件夹级文档添加到C#程序集？

我：我是.NET平台的新手

问题

在Java中，您可以通过创建package-info.Java或package.html文件并存储在package文件夹中，将包级别的文档添加到项目中。如何使用Visual Studio 2010在C#中向我的项目添加等效文档

背景

---

我喜欢在我所从事的源代码项目的包/文件夹级上下文中编写文档来描述我的动机。我已经非常习惯于使用多种语言（特别是Java）使用此工作流，我相信这是记录我的项目的一种好方法。

在.NET中，重点有点不同，它对生成IntelliSense信息有很好的支持。文档在您的指尖。我相信，当您使用VS一段时间后，您一定很熟悉它，请查阅“xml文档”

离线文档过去由NDoc负责，但支持它的人退出了他的项目。工人们填补了空缺。顺便说一句，最近似乎也有点滞后。

C#将自动将基于XML的三重斜杠注释转换为intellisense文档

///<summary>This method does something!</summary>
///<parameter name="p1">The first parameter</parameter>
///<return>true, if the method completed successfully</return>
public bool DoSomething(int p1){
  return p1 > 0;
}

///这个方法有作用！
///第一个参数
///如果方法成功完成，则为true
公共场所剂量测定（int p1）{
返回p1>0；
}

当您将项目编译成类库并在另一个项目中引用它时，上述内容将自动转换为有用的工具提示。此外，C#编译器还可以选择在DLL旁边生成包含所有这些注释的XML文件。这个XML文件可以作为MSDN风格的API参考输入（如前所述）并添加到文档项目中

Sandcastle工具有自己的项目和文档结构，因此如果要添加XML生成的Intellisense引用以外的内容，则需要启动一个辅助项目