首页 > 编程语言 >php 规范的注释

php 规范的注释

时间:2023-08-07 11:55:05浏览次数:32  
标签:函数 规范 信息 注释 指明 php 方法 变量 定义

/**
 * @name 名字
 * @abstract 申明变量/类/方法
 * @access 指明这个变量、类、函数/方法的存取权限
 * @author 函数作者的名字和邮箱地址
 * @category  组织packages
 * @copyright 指明版权信息
 * @const 指明常量
 * @deprecate 指明不推荐或者是废弃的信息MyEclipse编码设置
 * @example 示例
 * @exclude 指明当前的注释将不进行分析,不出现在文挡中
 * @final 指明这是一个最终的类、方法、属性,禁止派生、修改。
 * @global 指明在此函数中引用的全局变量
 * @include 指明包含的文件的信息
 * @link 定义在线连接
 * @module 定义归属的模块信息
 * @modulegroup 定义归属的模块组
 * @package 定义归属的包的信息
 * @param 定义函数或者方法的参数信息
 * @return 定义函数或者方法的返回信息
 * @see 定义需要参考的函数、变量,并加入相应的超级连接。
 * @since 指明该api函数或者方法是从哪个版本开始引入的
 * @static 指明变量、类、函数是静态的。
 * @throws 指明此函数可能抛出的错误异常,极其发生的情况
 * @todo 指明应该改进或没有实现的地方
 * @var 定义说明变量/属性。
 * @version 定义版本信息
 */

标签:函数,规范,信息,注释,指明,php,方法,变量,定义
From: https://www.cnblogs.com/fuqian/p/17611061.html

相关文章

  • 基于php的奶茶原材料交易系统
    随着社会的发展,社会的各行各业都在利用信息化时代的优势。计算机的优势和普及使得各种信息系统的开发成为必需。奶茶原材料交易系统主要的功能模块包括工作提醒、产品广告、产品分类、产品管理、订单管理、留言管理、会员管理、管理员管理、友情链接、系统设置等功能。系统中管理员......
  • 【9.0】Vue之项目规范
    【一】vue-cli创建项目【1】引入单页面应用(SPA)单页面应用(SinglePageApplication,简称SPA)是一种Web应用程序的架构方式。传统的多页面应用中,每次导航到新页面都会进行整个页面的重新加载。而SPA只有一个主页面(通常是index.html),页面的内容通过动态渲染来更新,不会重新加载整......
  • 异步请求返回处理之finally的用途,代码规范摸索【玩转JavaScript】
    前言最近在改动老代码时,发现了一个有趣的现象。对于异步请求返回结果处理中,使用finally做兜底处理,不同的页面并不统一,也就是有的页面使用了,有的页面没使用,没使用的页面增加了额外的失败的处理。所以finally到底要不要统一?本着代码规范化原则的思维,我准备一探究竟。文章速度finally......
  • msvc++工程之vs版本升级及工程目录规范
    为什么要升级msvc++工程版本对msvc++工程进行vs版本升级,一方面是可以使用较新的C++标准及对64位更好的支持。首先你需要对msvc++project文件有一定的了解,主要是vcxproj和vcxproj.filter这两个文件,升级的时候需要手动修改sln和vcxproj文件。vs(visualstuiod)中vc++工程的Filte......
  • 为react项目添加开发/提交规范(前端工程化、eslint、prettier、husky、commitlint、sty
    因历史遗留原因,接手的项目没有代码提醒/格式化,包括eslint、pretttier,也没有commit提交校验,如husky、commitlint、stylelint,与其期待自己或者同事的代码写得完美无缺,不如通过一些工具来进行规范和约束。eslinteslint是一个代码校验工具,用来规范项目代码风格。初始化通过n......
  • php简明手册(1)
    目录安装安装基于linuxsudodnfinstallphp安装postgresqlf支持sudodnfinstallphp-pgsql*基于源码编译tarzxfphp-x.x.xcd../php-x.x.x./configure--enable-fpm--with-mysqlmakesudomakeinstall创建配置文件,并将其复制到正确的位置cpphp.ini-deve......
  • LeetCode -- 722. 删除注释
     利用双指针来进行删除操作 classSolution{public:vector<string>removeComments(vector<string>&source){stringstr;for(autoit:source)str+=it+"'";intn=str.size();vector<string&g......
  • 前端多人协作之代码规范
    代码规范学习自并感谢Geekers-Admin和Hooks-Admin开源项目的作者HalseySpicy一、EditorConfigEditorConfig用于定义项目中的编辑器配置。可以确保团队成员在不同的编辑器中保持一致的代码风格和格式。......
  • 让 vscode 和 idea 一样注释后自动换行
    安装IDEAKeyBinding插件后发现无法和IDEA一般注释后换行,经过一番查询,如下解决:https://github.com/kasecato/vscode-intellij-idea-keybindings/issues/233#issuecomment-1491495313Ctrl+Shift+A搜索OpenKeyboardShutcuts(JSON),将以下代码加到末尾,注意JSON语法。{......
  • 《安富莱嵌入式周报》第319期:声音编程器,开源激光雕刻机,自制600W海尔贝克无刷电机,车用
    周报汇总地址:http://www.armbbs.cn/forum.php?mod=forumdisplay&fid=12&filter=typeid&typeid=104 更新视频教程:更新第7期ThreadX视频教程:如何实现RTOS高效的任务管理,抢占式调度,时间片调度和零中断延迟(2023-07-31)https://www.armbbs.cn/forum.php?mod=viewthread&tid......