Question

当尝试使用Docfx记录C＃项目时，我遇到了一个问题，可能是我自己一个白痴。但是，我已经阅读了docfx examples，并且没有看到任何明显的方法来纠正此问题。

运行docfx init -q时没有错误。当我运行docfx docfx.json --serve时也没有收到错误，完成后会收到Build succeeded. 0 Warnings 0 Errors消息，但是没有生成html文件。

由于api文件夹中的yml文件与项目中的类文件同名，因此它似乎也可以从我的项目中正确读取源文件。

如何获取docfx来为项目生成适当的html文件。 docfx docfx.json --serve的完整输出如下：

[19-07-04 05:07:47.020]Info:[MetadataCommand.ExtractMetadata]Using msbuild C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin as inner compiler.
[19-07-04 05:07:47.302]Info:[MetadataCommand.ExtractMetadata]Loading projects...
[19-07-04 05:07:50.379]Info:[MetadataCommand.ExtractMetadata]'C:/Users/Devvy/Source/Repos/TestProj/TestProj.csproj,C:/Users/Devvy/Source/Repos/TestProj/Display_Output.cs,C:/Users/Devvy/Source/Repos/TestProjException.cs,C:/Users/Devvy/Source/Repos/TestProj_Core.cs,C:/Users/Devvy/Source/Repos/TestProj/Module_Info.cs,C:/Users/Devvy/Source/Repos/TestProj/Opcode_Assembler.cs,C:/Users/Devvy/Source/Repos/TestProj/Opcode_Disassembler.cs,C:/Users/Devvy/Source/Repos/TestProj/Pattern_Tools.cs,C:/Users/Devvy/Source/Repos/TestProj/Payloads.cs,C:/Users/Devvy/Source/Repos/TestProj/Process_Info.cs,C:/Users/Devvy/Source/Repos/TestProj/PtrRemover.cs,C:/Users/Devvy/Source/Repos/TestProj/RopChainGenerator32.cs,C:/Users/Devvy/Source/Repos/TestProj/RopChainGenerator64.cs,C:/Users/Devvy/Source/Repos/TestProj/Thread_Info.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TestProj.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472_Lib.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/netstandard2.0.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Release/net472/TestProj.AssemblyInfo.cs' keep up-to-date since '7/4/2019 5:03:14 PM', cached result from 'C:/Users/Devvy/Source/Repos/TestProj/Documentation/api' is used.
[19-07-04 05:07:50.379]Info:[MetadataCommand]Completed Scope:MetadataCommand in 3384.2278 milliseconds.
[19-07-04 05:07:50.379]Info:Completed in 3389.2213 milliseconds


Build succeeded.
    0 Warning(s)
    0 Error(s)

Answer 1

Docfx为我们提供了静态代码文档。如果要正确地使用docfx输出静态网站。您应该执行以下步骤；

首先，您必须安装docfx。您有很多方法，但我推荐install with choco

choco install docfx -y

然后，您必须从NuGet添加项目docfx控制台程序包

Install-Package docfx.console -Version 2.33.0

现在打开项目文件夹或任何您想要创建的文件夹，然后run like that

docfx init

此答案的最好部分是您必须config you'r project docfx.json file like this

运行后

docfx --serve

我还找到了一个示例项目here

我认为您的问题是docfx文件配置。

Docfx说成功，但是没有生成输出文件

1 个答案: