我多次尝试使用 DocFx 构建文档站点。每次我运行docfx metadata
anddocfx build
时,该过程都会运行而没有任何错误,但 DocFx 只列出了我项目的几个类型和成员。
我尝试了几个 DocFx 版本;目前我正在使用版本2.58.9.0
。
文件结构:
我已经尝试过使用"**.cs"
而不是"**.csproj"
,结果相同。
我的docfx.json
:
{
"metadata": [
{
"src": [
{
"files": [ "**.csproj" ],
"cwd": "../Bugtracker"
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
文档/api 页面如下所示:
但是我的项目解决方案包含更多的类型和成员,其中很多包括 XML 注释;查看解决方案文件、类的屏幕截图。
我的项目设置如下:
当我将框架更改为 .NET Core 3.0 时,对于 DocFx 文档中显示的文件,我会收到以下警告 - 但奇怪的是,我没有收到解决方案中其他文件的警告: