摘要: 大佬给了我个任务,说内部人员需要查看项目的方法信息,特别是工具类的一些接口文档,起初叫我去研究Sandcastle,后经过了解引出几个更现代化的框架进行比对,最终产出如下的结论;且我是针对C#项目进行方案研究的,整体更注重于于C#的相关注释生成的文档; ##方案 ###1. Sandcastle S 阅读全文
posted @ 2022-11-16 16:10 Memoyu 阅读(226) 评论(0) 推荐(0) 编辑
摘要: 安装 安装包地址:docfx releases MSBuild是DocFX编译项目的必要环境,所以需要根据不同平台进行构建环境搭建: 在Windows环境下,需要使用Visual Studio Installer(vs >= 2019),单个组件 搜索 MSBuid进行安装; 在Linux/Mac环 阅读全文
posted @ 2022-11-16 16:07 Memoyu 阅读(504) 评论(0) 推荐(0) 编辑
摘要: 安装 安装包地址:Doxygen: Downloads Windows下一路next即可 操作 本案例使用doxygen-awesome-css样式进行自定义生成,所以不需要创建doxygen项目文件Doxyfile,只需要基于上述项目文件目录进行调整即可; 注意:任何文件路径中不能包含中文,不然构 阅读全文
posted @ 2022-11-16 15:55 Memoyu 阅读(311) 评论(0) 推荐(0) 编辑
摘要: 安装 参考:四种Sandcastle方法生成c#.net帮助类帮助文档 操作 使用Sandcastle生成Api文档需要使用对应程序集的注释xml + 程序集dll作为数据源,通过对xml + dll数据解析生成文档;所以主体步骤如下: 程序集资源生成 创建配置.shfbproj项目 编译构建文档 阅读全文
posted @ 2022-11-16 15:37 Memoyu 阅读(143) 评论(0) 推荐(0) 编辑