zoukankan      html  css  js  c++  java
  • 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,这是单行注释
  • 相关阅读:
    vim的额外功能
    vi的使用
    文件与文件系统的压缩
    其他常用的压缩与备份工具
    光盘写入工具
    XFS 文件系统的备份与还原
    打包命令:tar
    Linux 系统常见的压缩命令
    Windows10修改DNS
    Linux 磁盘与文件系统管理
  • 原文地址:https://www.cnblogs.com/Strive-count/p/6026003.html
Copyright © 2011-2022 走看看