showdoc_api.sh使用,本文为笔者亲身经历
showdoc_api.sh使用雷区
本文章为本人亲身体验,希望见到此文中有能力者能将此shell脚本漏洞告知showdoc开发团队(能自行修改shell脚本代码的大佬们请无视,我只是个小白~~^ v ^~~)
showdoc_api.sh使用教程
showdoc官方指南中已给出了详细教程贴,本文不多赘述,附链接地址
自动生成API文档
脚本雷区
在showdoc_api.sh的shell文本中,缺少对文件夹中特殊符号的检测;
本文笔者在使用过程中,由于项目文件名中带有 空格 字符,最终导致脚本将扫描路径重新定向到了根路径。
例如:我的项目名为 MyProject ,并将其放入
F:\Software Engineering\WorkSpace
目录下。需要注意的是,此处我的文件名目录Software Engineering中带有空格符号,最终运行脚本时,脚本的扫描路径直接重新定向到了
F:\
从根路径开始扫描文件,而不是我想要的从当前目录
F:\Software Engineering\WorkSpace
处开始扫描。以此为例,希望能对各位同样爱好开发的猿猿们有所帮助~