PHP之标准注释

约定不等于承诺〃 2022-01-28 14:39 166阅读 0赞

**格式化一下别人的PHP代码居然注释错乱了，正确的姿势原来在这：**

> 程序代码注释

1.  注释的原则是将问题解释清楚，并不是越多越好。
2.  若干语句作为一个逻辑代码块，这个块的注释可以使用/\* \*/方式。
3.  具体到某一个语句的注释，可以使用行尾注释：//。

/* 生成配置文件、数据文件。*/  
      
    $this->setConfig();  
    $this->createConfigFile();  //创建配置文件  
    $this->clearCache();         // 清除缓存文件  
    $this->createDataFiles();   // 生成数据文件  
    $this->prepareProxys();  
    $this->restart();

> 类的注释

/** 
    * 类的介绍 
    * 
    * 类的详细介绍（可选。）。 
    * @author      
    * @since          
    */  
    class Test   
    {  
    }

> 函数头部注释

/** 
    * some_func  
    * 函数的含义说明 
    * 
    * @access public 
    * @param mixed $arg1 参数一的说明 
    * @param mixed $arg2 参数二的说明 
    * @param mixed $mixed 这是一个混合类型 
    * @since 1.0 
    * @return array 
    */  
    public function thisIsFunction($string, $integer, $mixed) {return array();}

> 文件头部模板

/** 
    *这是一个什么文件 
    * 
    *此文件程序用来做什么的（详细说明，可选。）。 
    * @author      
    * @version     $Id$ 
    * @since       
    */

[https://www.cnblogs.com/liangzia/p/6223129.html][https_www.cnblogs.com_liangzia_p_6223129.html]

[https_www.cnblogs.com_liangzia_p_6223129.html]: https://www.cnblogs.com/liangzia/p/6223129.html

发表评论取消回复

表情：

评论列表（有 0 条评论，166人围观）

还没有评论，来说两句吧...

相关阅读

相关 php mysql 语句生成工具,php 之批量生成 mysql 语句注释

\{ parent::\_\_construct();/\加载项\/ $this->load->model('Convers', 'conv'); \}/\\ /\\

悠悠/ 2023年01月17日 03:20/ 0 赞/ 133 阅读

相关 php注释代码_如何以及为什么在您PHP代码中进行注释

php注释代码 A comment in [PHP][] code is a line that is not read as part of the program. It

淩亂°似流年/ 2022年12月06日 15:37/ 0 赞/ 233 阅读

相关 PHP面向对象的标准

你不必严格遵守这些原则，违背它们也不会被处以宗教刑罚。但你应当把这些原则看成警铃，若违背了其中的一条，那么警铃就会响起。 (1)所有数据都应该隐藏在所在的类的内部。

ゞ浴缸里的玫瑰/ 2022年09月19日 10:45/ 0 赞/ 167 阅读

相关 PSR PHP 标准规范

简介 PSR 是 PHP Standard Recommendations 的简写，即 PHP 标准规范。 PSR 由 PHP FIG 组织制定的 PHP 规范，是 P

男娘i/ 2022年05月26日 10:52/ 0 赞/ 264 阅读

相关 PHP注释规范

PHP支持3种风格的程序注释： 1、 C++风格的单行注释（//） <?php echo '使用C++风格'; //这就是C++风格

不念不忘少年蓝@/ 2022年05月16日 04:15/ 0 赞/ 300 阅读

相关 PHP 代码注释解释

@access 使用范围：class,function,var,define,module 该标记用于指明关键字的存取权限：private、public或protece

悠悠/ 2022年05月10日 13:54/ 0 赞/ 241 阅读

相关 PHP标准库 (SPL)

1.栈操作 $q = new SplStack(); $q[] = 1; $q->push(4); $q->add(4,5);

小咪咪/ 2022年04月05日 10:49/ 0 赞/ 226 阅读

相关 PHP 标准规范：PSR（单）

-------------------- [PHP PSR 标准规范][PHP PSR] -------------------- PSR 是 PHP Standard

矫情吗；*/ 2022年02月19日 02:25/ 0 赞/ 279 阅读

相关 PHP之标准注释

格式化一下别人的PHP代码居然注释错乱了，正确的姿势原来在这： > 程序代码注释 1. 注释的原则是将问题解释清楚，并不是越多越好。 2. 若干语句作为一个逻辑代码块，

约定不等于承诺〃/ 2022年01月28日 14:39/ 0 赞/ 167 阅读

相关 php读取zip注释

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] $za = new ZipArchive();

左手的ㄟ右手/ 2022年01月14日 07:21/ 0 赞/ 193 阅读