• php注释规范


     

     

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

    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,这是单行注释
  • 相关阅读:
    Java基础知识:正则表达式
    NodeJs 中 将表单数据转发到后台
    单片机的远程升级
    一些开源协议
    物联网的一些例子
    python一些开源特色库
    qt练习
    网页编程学习笔记
    PCB相关
    工业控制系统
  • 原文地址:https://www.cnblogs.com/1358-com/p/6504379.html
Copyright © 2020-2023  润新知