DocFX 文档生成:隐藏 Public 方法
要隐藏一个 public 方法,可以使用 DocFX 的特殊注释来实现。以下是具体步骤:
- 在你想要隐藏的方法上方添加特殊注释 '///
'。 - 在 DocFX 的配置文件(一般是 docfx.json)中,找到 'build' 节点下的 'markdown' 子节点,添加以下配置:
"build": {
"markdown": {
"disableDefaultGroup": true,
"disableMemberLevelMacro": true
}
}
- 重新运行 DocFX 生成文档,你会发现该方法已经被隐藏了。
需要注意的是,这种方法只是在生成的 markdown 文档中隐藏了该方法,实际上该方法仍然可以被调用和使用。如果你想要完全隐藏该方法,可以考虑将其修改为 'internal' 访问级别。
原文地址: https://www.cveoy.top/t/topic/qsTg 著作权归作者所有。请勿转载和采集!