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

Question

我：我是.NET平台的新手。

问题

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

背景

我喜欢在我正在处理的源代码项目的包/文件夹级上下文中编写描述我的动机的文档。我已经习惯了各种语言（特别是Java）的工作流程，我相信这是记录我的项目的好方法。

Answer 1

C＃会自动将基于XML的tripple-slash注释转换为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;
}

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

Sandcastle工具有自己的项目和文档结构，因此如果您要添加除XML生成的Intellisense参考之外的任何内容，您将需要启动一个辅助项目。

Answer 2

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

离线文档曾经被NDoc覆盖，但支持它的人退出了他的项目。 Sandcastle project占了上风。这几天似乎有点迟钝。