PHP 语法:程序注释 1 个改进

问题

那么我们在编写 PHP 代码的时候,怎么做才能让别人更容易理解和读懂自己编写的代码呢?

回答

在编写程序 PHP 代码的时候,我们可以使用代码注释来解释代码块的含义以及功能。如果我们能够正确地使用注释,那么我们的代码就会变得让人容易读懂,让人容易接受。

使用方法

在 PHP 中我们可以通过使用 //#/*......*/ 三种符号进行注释:

<?php
// 这是单行注释。

# 这也是单行注释。

/*
这是多行注释块
它横跨了
多行。
*/

示例

当然,并不是一个脚本有注释就是好的,我们需要标注的是有参考价值的注释,而不是无用信息。

错误示例:

例 1 —— 无用的注释

<?php
/**
 * Created by PhpStorm.
 * User: Administrator
 */

/**
 * This is a function.
 */
function add($val_1, $val_2) 
{
    $res = $val_1 + $val_2;

    return $res;
}

在例 1 中我们可以看到两个注释块,但是从中我们获取不到任何和代码相关的有用信息。

例 2 —— 有参考价值的注释

<?php

/**
* 该函数将会输入的两个参数进行和运算,并返回运算结果。
*/
function add($val_1, $val_2) 
{
    $res = $val_1 + $val_2;

    return $res;
}

在例 2 中我们可以从注释中获取到函数 add 的功能,所以正确的注释应该让代码阅读者更容易读懂代码,而不是分散其注意力。

php
本文为 Wiki 文章,邀您参与纠错、纰漏和优化
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!