项目做完后一般会要求写文档,其中包括两部分 一是代码文档,一是数据库文档 我一般使用navicat管理数据库,在无法使用navicat的情况下使用phpmyadmin 数据表和字段一般都是写有注释的,尤其是大项目 如果可以直接将表导出并且包含注释,那么就达到了自动化构建数据库文档的目的。

经过尝试navicate是不行的 phpmyadmin虽然有word格式导出,但不包含注释(是不是很蛋疼)

经过我尝试每种格式的导出,最终发现了一个解决方案

导出为 OpenDocument Text 格式的文件,也就是后缀名为 .odt 选择仅导出结构,勾选包含注释 然后网上搜 odt 转 word 有很多提供在线转换服务的网站 比如https://cn.office-converter.com/ODT-to-Doc 这时转换为word 我们的目的就达到了! 从此写好注释,文档一键生成。

代码文档可以使用代码遍历项目文件的方式,目前因为代码注释格式不规范,仅能自动生成目录树。 以后另起文章分享自动生成代码文档。