0

在尝试使用 Docfx 来记录 C# 项目时，我遇到了一个问题，这可能是因为我自己是个白痴。但是，我已经阅读了docfx 示例，但没有看到任何明显的解决问题的方法。

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

它似乎也正确地从我的项目中读取源文件，因为 api 文件夹具有与项目中的类文件同名的 yml 文件。

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

[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)
4

1 回答 1

0

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

首先你必须安装docfx。你有很多方法，但我建议用 choco 安装 

choco install docfx -y

那么你必须docfx从 NuGet 添加你的项目控制台包

Install-Package docfx.console -Version 2.33.0

现在打开您的项目文件夹或任何您想要创建的文件夹然后像这样运行 

docfx init

现在这个答案的最佳部分你必须像这样配置你的项目docfx.json文件

跑完之后

docfx --serve

我还在这里找到了一个示例项目

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

于 2019-10-24T14:55:38.430 回答