phpstrom中自定义Live Templates支持apidoc文档注释

最新推荐文章于 2024-08-22 09:20:18 发布
最新推荐文章于 2024-08-22 09:20:18 发布
阅读量3.2k 收藏 1
点赞数
分类专栏： php 文章标签： phpstrom ide php
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zxian610/article/details/79317356
版权
本文介绍了如何在phpstrom中自定义Live Templates以支持apidoc文档注释，通过设置动态模板，提高编写apidoc注释的效率，简化web api文档的创建过程。
摘要由CSDN通过智能技术生成
前言

最近工作中经常使用到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？
  1. 打开Live Templates自定义的设置界面：File>Settings>Editor>Live Templates，
    这里写图片描述
最低0.47元/天 解锁文章
详细:idea2021自定义注解模板live Templates
yuec1998的博客
08-05 3674
在编写代码的时候，我们都会给创建的类或者，所写的方法，又或者是变量添加一个注解，以下图为例： 图中一共3种注释模板，其中第一种和第三种显然不是自己每次去添加的，而是使用idea快捷键自动生成的注解模板，那么我们盖怎么实现呢？ 1.在idea设置中搜索 live Templates 2、可以点击最右边的+号选项2创建一个自定义的快捷键模板，这里使用user，接着还是再点+，选择选项1，开始创建一个自定义的快捷键模板 3、以方法注解为例子 我们想要每次敲一个再加一个回车键，就自动生成一个方法注解，例如我
IntelliJ idea自定义模板Live Templates
在路上
06-02 1151
1、点击File-->Setting(Ctrl+Alt+S)-->Live Template，点击右侧的+号，选择Template Group2、输入MyGroup（也可以输入自定义的名称。我写的是My），然后点击OK3、选中My之后，再次点击右侧的+号，选择Live Template下图是 正确是 public static void main(String[] args)   粗心...
PhpstormLiveTemplates:PhpStorm 实时模板
07-01
PhpstormLive 模板 PhpStorm 实时模板
PhpStorm-LiveTemplates:PhpStorm-LiveTemplates 的集合
06-20
PhpStorm-LiveTemplates PhpStorm-LiveTemplates 的集合 安装 首先，找到您的配置文件夹。 Windows: <your>\.WebIde<version>\config Linux: ~\.WebIde<version>\config MacOS: ~/Library/Preferences/WebIde<version> 在我的 MacOS 上，它会是~/Library/Preferences/WebIde80所以你必须根据你的平台调整命令。 有一个templates/目录。 它包含带有实时模板的 XML 文件。 在templates/目录中创建一个 git 存储库并拉取模板 $ cd ~ /Library/Preferences/WebIde80/templates $ git init $ git re
PHP-APIDoc 使用教程
最新发布
gitblog_00444的博客
08-22 676
PHP-APIDoc 使用教程 php-apidocGenerate documentation for php API based application. No dependency. No framework required.项目地址:https://gitcode.com/gh_mirrors/ph/php-apidoc 项目介绍 PHP-APIDoc 是一个用于自动生成 API 文档...
phpstorm中添加自己的函数注释
热门推荐
幽篁晓筑的博客
08-26 1万+
phpstorm中添加自己的函数注释 首先我们要添加自己的一套模板，点击 file-&gt;settings-&gt;editor-&gt;live Templates 点击右侧加号，选择第二个选项“template group”，创建一个分组。 选中刚才添加的分组，点击右侧加号，选择第一个选项“live template”添加一个具体模板。 按照图中步骤：其中第四步不一定要...
phpstorm之Live Templates代码片段
aipan1222的博客
11-04 350
A)我们先介绍一个代码片段最基本的功能，我们要实现的目标是在html文件或者php文件里打入“quan”这4个字符，就能出现站长圈的网址“http:/ /wwwquan .com”。怎么实现呢？ 1).打开“File”-“Settings”，找到并点中“Live Templates”， 2).点右边的+号（7.0版本有两个选择，选择Live Templates）， 3)...
PHPStorm 的动态模板
FishTail
03-28 899
PHPStorm 的动态模板 概述 PHPStorm 中有个功能叫 Live templates ，翻译成中文就叫做动态模板或实时模板。这个功能 PHPer 们肯定或多或少都用过，只是不知道而已。接下来我给大家讲一讲动态模板是什么，以及如何自定义动态模板。 动态模板可以让你快速的插入常用或自定义代码结构到你的代码文件中，也就是能够让你输入几个关键字，就能出来整个代码结构。 如何使用？ 动态模板的设置位置在File -> Settings -> Editor -> Live Templat
Kotlin之自定义 Live Templates详解(模板代码)
08-19
那么，在Kotlin开发中，我们也可以自定义Live Templates来生成相应的代码片段。 自定义Live Templates的过程可以分为三步：首先，我们需要明确最终要生成的代码；其次，我们可以根据Java版本的模板来编写Kotlin版本...
IntelliJ IDEA自定义Live Templates
Kris_Wilson的博客
05-25 2113
自定义Live Templates可以极大提高工作效率，我的设置如下： 第一步、添加Group Ctrl+Alt+A输入live，选择Live Templates（Settings） 点击右侧绿色加号，选择Template Group，并输入self（根据自己需要设置Group的Name） 第二步、添加自定义template 以下所有Define均设置为Java ...
phpstorm 创建php自定义注释样式！！！
可爱的狼
11-25 1122
/** * Version : 1.0 * Create by : 可爱的狼<798959000@qq.com> * Copyright : copyright (c) 百度, www.baidu.com * Created on: ${DATE} ${TIME} */
PHPstorm 添加代码模版,快速生成代码 live template
u011436748的博客
01-14 1011
apidoc 自动生成api文档
aawuwuwuxx的博客
02-07 3031
下载node.js 安装安装npm淘宝镜像安装apidoc项目应用目录目录下新建apidoc.json文件，例如tp的application目录 { "name": "JD SHOP Api", "version": "1.0.0", "description": "JD SHOP Api", "title": "JD SHOP Api", "url" : "http://1
PhpStorm代码注释
weixin_34194317的博客
01-07 1847
2019独角兽企业重金招聘Python工程师标准>>> ...
phpstrom函数注释模板_PhpStorm函数注释的设置
weixin_39861823的博客
01-17 396
PhpStorm函数注释的设置一、总结一句话总结：添加模板 添加变量应用变量a、添加模板，添加變量，在(PhpStorm中setting-》Editor-》LiveTemplate)中添加模板添加變量$DATE$ $TIME$b、應用變量，在(setting-》Editor-》FIle and Code Template-》Includes)中應用變量/*** Notes:* User: ${U...
PHPStorm 设置文件头、类、函数注释模板
weixin_46397725的博客
07-21 1549
1、进入File | Settings | 编辑器 | File and Code Templates 2、设置PHP File Header /** * @user: tom * @date: ${DATE} * @createTime: ${TIME} * @company: 科技有限公司 http://www.keji.com */ 2、设置PHP Class Doc Comment 3、设置PHP Class Doc Comment 注：当新建函数后，在函数上面输入【/*\】然后
phpstrom函数注释模板_PHPSTORM模板变量注释
weixin_42318815的博客
02-28 1350
类似于这种注释，方便使用。有两种方式一种是生成PHP文件时，自动生成，一种是手动生成。第一种：自动生成一图解释所有。这么配置就OK了。这种方法还有一种就是，在包括里边编写，直接引用，先写PHP File Header文件然后引用。第二种方法，就是自己创建了，随时使用。还是找设置，但是这回找的是模板自己新建了一个模板，叫做，user,然后在里边简历了一个叫Notes的快捷方式(姑且这么叫)。在左下角...
利用apidoc在注释里写API文档
c67_dongxue的博客
10-31 566
本文基于node.js的代码注释编写。 程序员都不喜欢写文档，但是程序员习惯写注释。所以今天给大家安利一个注释文档的工具——apidoc，一个在注释里边编写API文档的小工具！ 由于经验以及英文水平问题，文中很有可能会有错漏，各位大神如果看出来了，麻烦指出一下。谢谢～ 安装apidoc npm install -g apidoc 运行 apidoc -i myapp/ -o ...
后台开发使用Swagger自动生成api接口文档
u013519290的博客
03-24 634
Swagger可以帮我们实现生成api接口文档 适用于 Teams | 的 API 文档和设计工具斯瓦格 (swagger.io)
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值