PHPDOC文档工具注释风格整理

自动生成PHP文档工具PHPdocument的Api文档之中标签注释风格集锦。

官网Api链接:

https://docs.phpdoc.org/references/phpdoc/index.html

范例:从上面的看就是非常凌乱的注释风格,非常随性,有点low,现在规范一下,在  http://php.net/manual/zh/  并未找到注释风格的章节说明,那么就以开源工具phpdoc的注释风格为准好了。

由于phpdoc文档说明很多而且很多并没用到的,网站打开又比较慢,那么在这里就整理一个较常用的注释模板

不过以前一直以@method(其实用来说明函数内部调用的魔术方法)来声明方法名称,想想,也没什么问题哈哈,开心就好,大致规范一下就好,免得越跑越远了,嘿嘿

常用的不过 方法名称、参数、作者、返回值、示例:

    /**
        * 测试方法
        * @author My Name <[email protected]>
        * @link  /index/test
        * @param  $_POST[‘PRONUM‘]; 商品数量 int
        * @param [ Type ] [name] [<description>]
        * @param [ int ] [$_POST[‘PROID‘]] [<商品ID>]
        * @copyright 2017-12-16 php group
        * @return [array] [成功的时候返回{‘status‘:true,‘data‘:‘success‘,‘code‘:0}]
        * @example 示例说明,文字数组等等diy
        * @version 1.0.1
    */
    function test()
    {
        echo ‘i am test‘;
    }

参考博客:

https://www.cnblogs.com/hellohell/p/5733712.html
时间: 2024-10-05 16:12:59

PHPDOC文档工具注释风格整理的相关文章

app后端开发二:API接口文档工具

悲伤的历史 在进行app后端开发过程中,后端会提供出来很多的api接口供前端开发使用,为了让前端开发人员顺利使用,我们会写好一份文档,告诉他们这个接口你该用 GET 还是 POST 来访问,同时访问的时候该给我传递一些什么参数,以及正确的时候我会返回什么给你,已经返回的数据样式以及字段解释等等这些事情,我们都需要在文档中写好写清楚. 在 app后端开发一:基于swagger-ui构建api接口文档工具 这篇博客中,我写了 swagger-ui 的好处以及优势.但是在使用过程中,发现不够给力.我想

app后端开发一:基于swagger-ui构建api接口文档工具

声明 之前写过关于app后端开发的一系列文章,那是我第一次做app后端开发,存在很多不足,本想好好修改一下,想想还是重新写吧,这样子也能让我博客文章看起来多一点嘛,万一以后找工作,别人一看我博客这么多内容,是不是很屌? 这次文章先从构建resetful风格的api文档工具开始.没有一个好的文档工具,在app前端人员开发过程中会导致开发效率极低,而且时不时的,他们就来找你跟他们断点一下. 我的文档经历 这里先不讨论我的数据传输是否合理,仅仅以这些数据作为一个演示.后面会有专门的章节进行app数据传

?生成chm文档工具- Sandcastle -摘自网络

Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具.它从dll文件及其xml注释文件能够 生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为 我们提供完美的.NET类库文

数据字典生成工具之旅(2):数据字典生成工具及文档工具作用介绍

上一篇介绍完了整个架构和功能,这一篇将更加详细介绍功能和操作,将会以实际例子帮助理解!(预告:下一篇正式进入实现原理讲解) 阅读目录 开始使用工具 工具全景图 工具源代码下载 学习使用 回到顶部 开始使用工具 日常工作你是通过什么工具来创建表的呢? 1.通过SqlServer自带的新建表的功能实现,或者直接写Create Table(.....)语句.能更加便捷的方式创建吗?这样创建的表便于后续维护和学习吗? 2.通过PowerDesign创建表,很直观,然后导出表的创建语句.模拟一下做学生信息

数据库文档工具

http://ddbuildtools.codeplex.com/  数据库文档工具

JavaScript(3)——文档工具

文档工具 LEARN HTML = 教程 HTML REFERENCE = 字典 HTML + CSS + JAVASCRIPT = DYNAMIC  HTML 推荐浏览器: Chrome浏览器(有丰富有利于开发者分析的工具) 善变的网页 永远不要相信网页的东西:因为你可以更改浏览器的内存从而改变页面显示内容: 根据意义记忆标签名: div = divide p = paragraph ul = unordered list i = italic b = bold hr = horizontal

Python Django框架实现商城项目源码加设计文档和注释

Python Django框架实现商城项目源码加设计文档和注释 链接:https://pan.baidu.com/s/1yN2iBgx3zmpTkoY8u1LWRg 提取码:lfsx 非常完整的django项目源码,分享给撸友们,不管是学习还是深造,都是可以学习借鉴的!! 原文地址:https://www.cnblogs.com/zyxlovesjy/p/12115491.html

【Lua】LDoc生成Lua文档工具的使用

参考资料: http://my.oschina.net/wangxuanyihaha/blog/188909 LDoc介绍: LDoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了.而LDoc则是一直在更新中,所以现在选择LDoc来给Lua生成文档是更好的选择,LDoc的Github主页. LDoc的一个优点就是,它的目的是为了和LuaDoc兼容并且拓展LuaDoc的功能而制作的,

一键给PDF文档加注释,简单免费!

福昕PDF阅读器是我们阅读PDF文档比较常用的工具,阅读的时候,我们经常会做一些注释,但你知道如何做PDF注释才是最快的吗? 打开"定制功能区" 在福昕阅读器导航栏的空白区域,点击鼠标右键,选择"定制功能区": 设置.操作.批量删除注释 弹出弹窗"自定义工具栏",点击"键盘"-"注释",设置常用注释的快捷键: 选中文本,按下设置的快捷键即可快速注释,如需要批量删除注释,可点击"选择"--