问题描述
我正在编写一个 C# winforms 应用程序,我想用 XML 注释为我的代码创建文档。但是,似乎我做错了什么,无法弄清楚是什么。目前,为了生成 HTML 文档,我使用 DocFX (但我也尝试过 sandcastle ,但结果相同)。创建 XML 文件和 HTML 文档时,它似乎只包含我的主要 Form1.cs
类(这很有趣,因为在该特定文件中我没有任何 XML 注释)。其他 .cs
文件(由 XML 注释组成)不包括在内(它们在整个开发过程中通过 Visual Studio 添加到项目中,右键单击项目 -> 添加 -> 新项目 -> C# 类)。这是我的docfx.json
:
{
"Metadata": [
{
"src": [
{
"files": [
"*.cs"
],"cwd": ".","exclude": [
"**/obj/**","**/bin/**","_site/**"
]
}
],"dest": "obj/api"
}
],"build": {
"content": [
{
"files": [
"api/**.yml"
],"cwd": "obj"
},{
"files": [
"api/*.md","articles/**.md","toc.yml","*.md"
],"exclude": [
"obj/**","_site/**"
]
}
],"resource": [
{
"files": [
"images/**"
],"overwrite": [
{
"files": [
"apidoc/**.md"
],"dest": "_site","template": [
"default"
]
}
}
而且,我的文件层次结构如下所示:
如何在 XML 创建中也包含其他文件?
解决方法
会不会是没有生成文档的类是内部类?我相信默认情况下只会为公共类生成文档。