精华内容
下载资源
问答
  • PHP注释数组(键,值)
    2021-03-26 12:23:29

    我使用Netbeans 8.0.2.

    有没有办法声明(并自动完成使用)@return数组批注的数组键和值类型?

    喜欢:

    @return array[string]Class2

    或类似:

    @return Class2[string]

    因此,Netbeans在以下foreach上自动完成应该没有问题:

    foreach($aArray as $sString => $oClass2){ ... }

    我知道以下注释方式:

    @return Class2[]

    但是以这种方式,我不知道如何获取字符串键的自动完成功能.

    当然,“字符串”-没有自动完成功能,但是假设我们要添加另一个Object而不是字符串作为Key,那么如何通知我的IDE使其知道并获得正确的自动完成功能?

    解决方法:

    我正在使用netbeans,这种方式很好用:

    /* @var $data['a'] \SomeClass */

    /* @var $data['b'] string */

    $data = array(

    "a" => new \SomeClass(),

    "b" => "Dump string"

    );

    在netbeans中进行此类注释时,使用单个*很重要.

    标签:annotations,arrays,php

    来源: https://codeday.me/bug/20191120/2040615.html

    更多相关内容
  • 怎么在php中添加注释

    2021-04-08 11:27:04
    注释在写代码的过程非常重要,好的注释能让你的代码读起来更轻松,写代码的时候一定要注意注释的规范。php里面常见的几种注释方式:1.文件头的注释,介绍文件名,功能以及作者版本号等信息/***文件名简单介绍**...

    a0ce28899001c92e78528fdcf9a508e9.png

    注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。

    php里面常见的几种注释方式:

    1.文件头的注释,介绍文件名,功能以及作者版本号等信息/**

    *文件名简单介绍

    *

    *文件功能。

    * @author alvin 作者

    * @version 1.0 版本号

    */

    2.函数的注释,函数作用,参数介绍及返回类型/**

    * 函数的含义说明

    *

    * @access public

    * @param mixed $arg1 参数一的说明

    * @param mixed $arg2 参数二的说明

    * @param mixed $mixed 这是一个混合类型

    * @return array 返回类型

    */

    3.类的注释,类名及介绍/**

    * 类的介绍

    *

    * 类的详细介绍(可选。)。

    * @author alvin 作者

    * @version 1.0 版本号

    */

    4.多行注释/* php注释语法

    这是多行注释。*/

    5.单行注释$n = 10; //数量n,这是单行注释

    以上便是php注释规范内容,仅供大家参考。

    相了解更多相关问题请访问PHP中文网:PHP视频教程

    展开全文
  • PHP代码注释规范

    2020-09-05 14:44:55
    团队共同开发过程注释对于帮助开发人员理解系统和有效地工作是必不可少的,但是注释的作用远远不止于此。文档抽象也扮演着重要的角色;没有注释,就无法隐藏复杂性。最后,编写注释的过程如果处理正确,...

    一、PHP注释的方式

    • // 这是单行注释
    • ‘ # ’ 这也是单行注释
    • /** 多行注释块 */

    PHP 代码中的注释不会被作为程序来读取和执行。它唯一的作用是供代码编辑者阅读。

    二、PHP程序标准注释的规范准则

    在项目代码内,文档在软件设计中起着至关重要的作用。在团队共同开发过程中, 注释对于帮助开发人员理解系统和有效地工作是必不可少的,但是注释的作用远远不止于此。文档在抽象中也扮演着重要的角色;没有注释,就无法隐藏复杂性。最后,编写注释的过程如果处理正确,实际上将改进系统的设计。

    类、文件注释

    1. 文件注释使用 PEAR 推荐的多行注释方式,不能使用 // 来注释
    2. 所有类必须添加说明信息,推荐项目包括:创建者信息、创建时间、更新时间、更新说明、版本号、程序(文件)描述、项目名称等,注释信息可根据需要添加或减少。

    实例说明

    /** 
    *此文件程序用来做什么的(详细说明,可选。eg:人资模块 —— 部门管理:控制器)。
    * Class 类名称(DeptController)
    * @package 	   文件路径(XXX/XXX/Controller)
    * @author      XXX<XXX@163.com> 
    * @version     $Id$ 
    * @since        1.0 
    */
    class DeptController {
    
    }
    

    方法注释

    1. 抽象方法说明、方法函数外部说明推荐使用 PEAR 推荐的多行注释方式,不推荐不能使用 // 来注释
    2. 方法函数内部代码注释时单行使用 // 注释,多行推荐使用/** ... */ 来注释
    3. 必须说明返回值、参数和实现功能

    实例说明

    /** 
    *  
    * 函数方法说明 (XXX-部门管理-XXX模块-创建)
    * 函数方法名称 (actionDeptCreate)
    * @access public 
    * @param mixed $arg1 参数一的说明 
    * @param mixed $arg2 参数二的说明 
    * @return array 
    */
    public function actionDeptCreate(mixed $arg1, mixed $arg2 = false): array
        {
        	//代码编写
            rerturn [];
        }
    

    代码注释

    1. 使用 // 来单行注释代码片段、业务逻辑等
    2. 使用 /** ... */ 来多行注释代码片段、业务逻辑等

    特殊注释

    // TODO :标记待办的业务逻辑
    // FIXME :此处存在错误,需要检查修补

    实例说明

    if (true) {
    	// FIXME 拼接查询条件出错、需稍后处理
        // TODO 需求待协商,稍后处理
    }
    

    其他说明

    • 注释中建议使用中文,不建议使用英文
    • 注释要与注释对象对齐
    • 后期修改代码时要同时修改注释
    • 注释掉的代码要尽量使用注释说明
    • 注释恰到好处,即可语义清晰之处尽量不要使用注释,以免本末倒置,增加后期代码维护的工作量

    三、PHP常用注解方法

    /**
    * @access        该标记用于指明关键字的存取权限:private、public或proteced使用范围:class,function,var,define,module
    * @author        指明作者
    * @copyright     指明版权信息
    * @const         使用范围:define 用来指明php中define的常量
    * @final         使用范围:class,function,var 指明关键字是一个最终的类、方法、属性,禁止派生、修改。
    * @global        指明在此函数中引用的全局变量
    * @name          为关键字指定一个别名。
    * @package       用于逻辑上将一个或几个关键字分到一组。
    * @abstrcut      说明当前类是一个抽象类
    * @param         指明一个函数的参数
    * @return        指明一个方法或函数的返回值
    * @static        指明关建字是静态的。
    * @var           指明变量类型
    * @version       指明版本信息
    * @todo          指明应该改进或没有实现的地方
    * @link          可以通过link指到文档中的任何一个关键字
    * @ingore        用于在文档中忽略指定的关键字
    */
    
    展开全文
  • java怎么注释

    2021-02-12 10:45:25
    给开发维护人员看的,不是给平台计算机看的Java,有3种标记的注释的方式: (推荐学习:java课程)//单行注释System.out.println("welcome CSDN");//打印输出welcome CSDN多行注释:/* */public class HelloWorld{...

    080a2e10c8a8215d1d465015fa418a37.png

    注释:就是代码意义的解释

    代码量比较多,容易忘记,加标注加解释–>给开发维护人员看的,不是给平台计算机看的

    在Java中,有3种标记的注释的方式: (推荐学习:java课程)

    //单行注释System.out.println("welcome CSDN");//打印输出welcome CSDN

    多行注释:/* */public class HelloWorld{

    /*

    *main方法程序的入口

    */

    public static void main(String[]args){

    }

    }

    文档注释:/** */package com.bdqn.output;

    /**

    *@version 1.1

    *@author 王靖文

    */

    public class HelloWorld{

    public static void main(String[]args){

    System.out.println("welcome CSDN");

    }

    }

    警告:在Java中,/**/注释不能嵌套。也就是说,不能简单地把代码用/*和*/括起来作为注释,因为这段代码本身也可能包含一个*/。

    展开全文
  • 从我所做的研究,我似乎找不到一个正确方法来格式化多行phpdoc @param行。推荐的方法是什么?以下是一个例子:/*** Prints 'Hello World'.** Prints out 'Hello World' directly to the output.* Can be used to ...
  • php代码添加规范的注释

    千次阅读 2017-08-22 16:06:31
    phpdocumentor注释分为文档性注释和非文档性注释。 所谓文档性注释,是那些放在特定关键字前面的多行注释,特定关键字是指能够被phpdoc分析的关键字,例如class,var等,具体的可参加附录1. 那些没有关键字...
  • 您可能已经看到说明,告诉您配置或源代码文件“取消注释”或“注释掉”行。 这是一个简单的过程,但对于不了解文件结构的人来说可能并非是不言自明的。 The interpreter ignores lines marked as comments, ...
  • PHP代码添加注释的几种格式: 1、用 // 开头,作为单行注释。例如:  // Author: mole  // Date:2012-2-8  echo "Welcome!"; ?> 2、用 # 开头,作为单行注释。例如:  # Author: mole  # ...
  • 添加必要的注释,对一个有责任心、有道德模范的前端必须具备的好习惯,可以大大提高代码的可维护性、可读性。首先大家需要熟悉一下html、css、js的注释的写法:html注释:css注释://注释内容 单行注释(不推荐使用,...
  • 于是预处理器处理的时候会先按第二条规则,看每行的末尾的那个字符是不是”\”,是的话,就下一行接到本行。然后把所有以//开头的注释和的块注释去掉。但是存在一个问题,对于big5的汉字而言,其第一个字节的编码...
  • 最简单的PHP测试题

    2021-04-14 10:37:43
    PHP 测验结果:16/20您的回答:1.PHP 指的是?个人主页:超文本预处理语言(Personal Home Page : Hypertext Preprocessor ,PHP)2.PHP 服务器...4. PHP ,所有的变量以哪个符号开头?$5.结束 PHP 语句的正确方法...
  • devc 使用教程 注释

    千次阅读 2021-05-20 03:36:17
    devc 使用教程 注释[2021-02-13 16:07:46]简介:使用DW在php中批量删除注释方法:1、删除单行注释,使用【//.*】进行正则替换;2、删除多行注释,使用正则表达式【/\*[\S\s]+?(?=\*/)\*/】查找匹配即可。使用DW...
  • 在PHP编程,我们经常会遇到处理数组的单元数据问题,比如对数组每个单元应用自定义函数。 一种方法是通过循环遍历整个数组,对每个单元调用自定义函数,然后用返回值替换原数组相应单元的值。这也是最常见和...
  • 最近没啥事开始正式用Eclipse 转入 idea工具阵营,毕竟有70%的开发者使用idea开发,所以它的魅力可想而知。刚上手大概有一天,就知道它为啥取名为 intelli(智能化)了,确实很智能,这还是一些小小的细节,当然...
  • C/C++语言对源文件做预处理的时候,有两条基本原则:1、凡是以//开头的为单行注释2、凡是以\结尾的代表此行尚未结束于是预处理器处理的时候会先按第二条规则,看每行的末尾的那个字符是不是”\”,是的话,...
  • 浅谈Python脚本开头及导包注释自动添加方法1、开头:#!/usr/bin/python和# -*- coding: utf-8 -*-的作用 – 指定#!/usr/bin/python是用来说明脚本语言是python的是要用/usr/bin下面的程序(工具)python,这个解释器,...
  • 注释在Python的使用

    千次阅读 2017-09-04 19:38:49
    一个程序当中可以没有注释,但是注释添加是为了以后复习...Python中添加注释有两种方式:第一种方式:单行注释在程序当中是以#号开头,#号右边的中文当做是注释。 如上图所示的注释添加方式,则是正确的。同样
  • java注释的报错

    2021-06-14 02:38:58
    java注释的报错[2021-02-10 09:56:03]简介:vue如何注释2020-11-18vue注释方法:1、html注释,代码为...【相关文章推荐:vue.js】vue注释方法每个代码块mysql更新注释方法:执行【ALTER TABLE `student` C...
  • 其它版本不知道,博主是5.0的版本,所以直接找到根目录下的public目录,下面有个.htaccess文件,但是这个框架,windows下安装,上面两项打开的话,是没有任何问题的,可以不带index.php。 然而Linux需要
  • 在php中的注释有两种 ...加注释也是为了增加可读性,方便我们自己和其他人方便看懂。关于php的变量很简单,php中的所有变量都是由 $ 开头,并可由数字,字母下划线组成,切只能由字母下划线开头。看如下正确
  • 当您同一应用程序构建许多功能时,事情往往会变得复杂。 数据位如此之多,包括函数,变量引用,返回值,参数……您希望如何保持? 无论是单独的项目还是团队项目,注释您的代码都是必不可少的也就不足为奇了...
  • Java,具有代码分割作用的符号就是分隔符。圆点“.”、分号“;”、花括号“{}”和空格具有特殊的分隔作用,我们将其统称为分隔符。;一条语句是以分号结尾的{} 一个语句块是以花括号开始和结束的[] 数组等的边界()...
  • 如何在PHP 8设置JIT

    千次阅读 2020-11-04 20:54:19
    PHP 8在PHP的内核中添加了JIT编译器,可以极大地提高性能。关于对实际Web应用程序的实际影响,需要做一些旁注,这就是为什么我对JIT的性能进行一些基准测试的原因(我也脚注列出了所有相关参考资料)。 我还想...
  • 这篇文章将介绍Go的编译运行、语法规范、注释转义及API标准库知识。这系列文章入门部分将参考“尚硅谷”韩顺平老师的视频和书籍《GO高级编程》,详见参考文献,并结合作者多年的编程经验进行学习和丰富,且看且珍惜...
  • java 代码注释风格

    2021-03-09 01:05:41
    java 代码注释风格[2021-01-30 16:29:10]简介:vue如何注释2020-11-18vue注释方法:1、...【相关文章推荐:vue.js】vue注释方法每个代码块php去除nbsp的方法:首先创建一个PHP代码示例文件;然后通过“pre...
  • Java 注释

    千次阅读 多人点赞 2015-11-18 23:48:25
    Java 注释 五月份得知入职YunOS, 开始学习Java, 断断续续学习和使用Java将近半年, 越来越喜欢这个工具, 因此后来被阿里拥抱变化之后, 拿到的的所有的offer都是Java研发; 一路走来, 踩了很多坑, 也有了一点小小的...
  • *************字符串的引入******************** 1.我们上一节介绍的四种基本数据类型还有一个字符串没有介绍,那么我们来认识一下什么是字符串。...4.很多其他编程语言,有字符(char)和字符串(strin
  • 如何对基因组序列进行注释

    万次阅读 多人点赞 2018-09-07 18:01:37
    基因组组装完成后,或者是完成了草图,就不可避免遇到一个问题,需要对基因组序列...同源预测(homology-based prediction):有一些基因蛋白相近物种间的保守型搞,所以可以使用已有的高质量近缘物种注释信息通过序...
  • Linux 常用命令汇总--注释

    千次阅读 2016-02-27 16:56:51
    目录   第一天 linux简介, 安装, 目录管理命令 第一章 linux简介 X-SHELL 软件的常用快捷键: ctrl+c 强制终止 ctrl+l 清屏 ...LAMP: linux+apache+mysql+php ...php和asp都各有

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 41,322
精华内容 16,528
关键字:

在php中添加注释的正确方法