前言
最近工作中经常使用到apidoc生成web api文档,代码中写apidoc的注释结构还是比较痛苦的,没有提示纯手敲,忘记一些结构还得去翻apidoc的文档,很痛苦的有木有……
后来我就在想,是否可以把apidoc的注释语法结构定义到phpstrom中,只需要简单快捷键或者命令,直接输出apidoc注释的完整结构。
什么是apidoc?
apiDoc creates a documentation from API annotations in your source code.
官方文档
上面的官方文档中的一句话:apidoc 在源代码中创建了一个API注释的文档。apidoc是nodejs开发的,编写好注释文档后,一条命令即可生成html接口文档。
如何定义Live Templates?
- 打开Live Templates自定义的设置界面:File>Settings>Editor>Live Templates,
- 新增一个分组PHP DOC
- 新增一个动态模板acc,我们可以将我们预期的自动补全注释结构编辑到模板当中,我这里直接放了一个完整的apidoc示例

本文介绍了如何在phpstrom中自定义Live Templates以支持apidoc文档注释,通过设置动态模板,提高编写apidoc注释的效率,简化web api文档的创建过程。
最低0.47元/天 解锁文章

被折叠的 条评论
为什么被折叠?



