如何使用Sandcastle NuGet包(EWSoftware.SHFB)生成文档？

Question

我正在尝试使用Visual Studio中的Sandcastle的NuGet包(EWSoftware.SHFB)为我的C#代码生成网站文档.事实是我不知道如何使用它.我从NuGet包管理器安装它然后我不知道如何处理它.

编辑我的文档项目并使用安装了默认安装程序的VS Sandcaslte扩展生成相应的网站没有问题.

谢谢您的帮助.

Answer 1

假设您已经有一个包含项目的解决方案，请将一个“文档”类型的新项目添加到您的解决方案中。

右键单击文档源并通过选择要记录的 csproj 添加源。

然后只是构建。

Answer 2

MsBuild.exe MyDocumentationProject.shfbproj生成了文档。这意味着该项目不能通过 VS 进行编辑，但可以使用命令行生成。

之前，如https://github.com/EWSoftware/SHFB/blob/master/NuGet/ReadMe.txt 所述：

1. ComponentPath必须设置该属性MyDocumentationProject.shfbproj以提供有关您正在使用的框架的反射信息。

   <PropertyGroup>
     <ComponentPath>$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.NETFramework.4.6</ComponentPath>
   </PropertyGroup>
   

2. SHFB 环境变量必须在MyDocumentationProject.shfbproj.

   <PropertyGroup>
     <SHFBROOT Condition=" '$(SHFBROOT)' == '' ">$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.2015.10.10.0\Tools\</SHFBROOT>
   </PropertyGroup>