网站首页 文章专栏 php如何的进行代码注释?怎么样才优雅?
php如何的进行代码注释?怎么样才优雅?
编辑时间:2019-08-01 09:57 作者:小铨 浏览量:170

代码注释在多人开发的时候非常重要,想象一下,一段代码没有任何主要你去结合运行的效果去看实现的逻辑,那是非常费劲的事。如果让别人看懂你写的代码,代码注释启动非常重要的作用。一个不会写代码注释的不是一个好的程序员。那么如何进行注释呢?

文件头部注释

  1. 1
    2
    3
    4
    5
    6
    7
    8
    /**
    *这是一个什么文件
    *
    *此文件程序用来做什么的(详细说明,可选。)。
    * @author 小铨
    * @version 1.0
    * @date 2xxx:xx:xx
    */

函数头部注释

  1. 1
    2
    3
    4
    5
    6
    7
    8
    9
    /**
    * 函数的含义说明
    * @author 小铨
    * @param int $arg1 参数一的说明
    * @param string $arg2 参数二的说明
    * @param mixed $mixed 这是一个混合类型
    * @return array
    */
    public function test($arg1, arg2, $mixed) {return array();}

类的注释

  1. 1
    2
    3
    4
    5
    6
    7
    8
    9
    /**
    * 类的介绍
    *
    * 类的详细介绍(可选。)。
    * @author 小铨
    */
    class Test
    {
    }

单独行注释

  1. 1
    $this->test(); // 测试方法调用

代码片段注释

  1. 1
    2
    3
    /*下面载入配置*/
    $this->setConfig();
    $this->createConfigFile()

当然,大家也可以根据个人习惯来注释~



    出自:铨程互动

    地址:www.wuhequan.cn

    转载请注明出处!


来说两句吧
最新评论
  • absolutely
    匿名用户 2020-09-07 15:24
    可以 相当优雅
0.074347s