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

Question

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

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

谢谢你的帮助。

Answer 1

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

如在https://github.com/EWSoftware/SHFB/blob/master/NuGet/ReadMe.txt上所述

1. 必须在ComponentPath中设置MyDocumentationProject.shfbproj属性，以提供有关正在使用的框架的反射信息。 $(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.NETFramework.4.6
2. 必须在MyDocumentationProject.shfbproj中有条件地设置SHFB环境变量。 $(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.2015.10.10.0\Tools\

Answer 2

假设您已经有了一个项目的解决方案，那么在解决方案中添加一个类型为“文档”的新项目。

​

​

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

​

​

那就建吧。

Answer 3

安装沙堡后，我使用Visual插件创建了文档项目。

在成功完成后，我在另一个项目中添加了以下构建后事件：

IF "$(ConfigurationName)"=="Debug" Goto Exit

ECHO Building SHFB help file via MSBuild
"$(SystemRoot)\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe"  /p:CleanIntermediates=True /p:Configuration=Release "$(SolutionDir)Documentation\Documentation.shfbproj"

:Exit

项目文档文件中的SHFB环境变量如下所示：

<!-- NOTE: Update the version number in the path (YYYY.M.D.R) to match the package version -->
<SHFBROOT Condition=" '$(SHFBROOT)' == '' ">$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.2016.9.17.0\tools\</SHFBROOT>

如果系统上没有安装沙城堡，它将使用NuGet包中的可执行文件。确保该版本与其他版本匹配。

这些文档链接可能有助于解决我忘记的问题：

• 在GUI之外构建项目
• 用团队构建生成文档