在本教程中, 我们将学习如何使用PHP注释为源代码编写优秀的文档。

PHP注释是代码中很重要的一部分。PHP注释使代码更易于阅读和维护。

PHP和其他大部分语言一样,支持两种类型的注释：

• 单行注释
• 多行注释

PHP单行注释

PHP一行注释来自C++和Perl。PHP单行注释用于只对一行代码进行注释。
它以井号（#）或（//）符号开头。符号后面的文本将会被PHP解释器忽略。

让我们看一下下面使用了PHP单行注释的示例：

<?php
 
$rate = 100;
$hours = 173;
$payout = $hours * $rate; // payout calculation

或使用井号（#）：

<?php
 
$title = '之路教程 PHP 注释'; # set default title

PHP多行注释

多行注释来自C/C++。它以/*开头，以*/结尾。每当注释需要跨越多行时，就可以使用多行注释。

下面的示例演示如何使用多行注释：

<?php
/*
 * 下面的示例演示了
 * 如何在PHP中使用多行注释
 * */
$x = 20;

有效编写PHP注释的技巧

要为你的源代码编写优秀的文档，你可以使用以下提示:

• 通过使用有意义的变量、函数或类名，让代码在不使用注释的情况下能表达它的意思。代码本身就是一个很- 好的注释。
• 不要写代码做了什么，而是为什么要写这段代码。让我们用代码来解释它的功能。然而，只有作为开发人员- 的您才知道为什么代码要这样做，因此您必须在注释中解释它。
• 写注释时，尽量简明扼要。
• 使用phpDocumentor为您的代码创建出色的文档。