SandcastleBuilder C#API文档生成器
自动生成 C#项目 API 文档的利器就是SandcastleBuilder。它能直接把你的 XML 注释放进 CHM 里,还支持 HTML、XML 导出,挺灵活。配置选项也多,标题、模板、作者信息随你改,做出的文档看起来还蛮专业的。
微软出的Sandcastle是底层引擎,SandcastleBuilder是在它基础上封装了一层 UI,界面还不错,点点配置基本就能跑。生成流程也不复杂:装好程序,建个项目,勾选一下模板和语言,点“生成”就能出 CHM 了。
CHM 格式适合 Windows 本地文档,一整个项目的 API 都能打包进去,搜索、打印都方便。你可以本地看,也能传到服务器让别人下载。
用的时候记得:代码注释要写完整,///
那种 XML 注释越规范,文档生成效果越好。批量多个项目也没问题,适合团队协作或者开源项目。
如果你平时要给项目写文档,又不想手撸 HTML,用SandcastleBuilder确实省不少事。你甚至可以自己改模板做成公司风格的文档,挺实用的。
4.23MB
文件大小:
评论区