关于注释的写法与疑问-php教程-PHP中文网

关于注释的写法与疑问

php中文网

发布： 2016-06-06 20:23:24

原创

1287人浏览过

最近在学习yii2,晃了几眼源代码，看到了类似怎样的注释：

<code>@ - 1

/**
 * User model
 *
 * @property integer $id
 * @property string $username
 * @property string $password_hash
 * @property string $password_reset_token
 * @property string $email
 * @property string $auth_key
 * @property integer $status
 * @property integer $created_at
 * @property integer $updated_at
 * @property string $password write-only password
 */

@ - 2

/**
 * @inheritdoc
 */
public static function tableName()
{
    return '{{%user}}';
}

@ - 3

/**
 * @var \common\models\User
 */</code>

登录后复制

不知道为什么要怎样写。求路过大神赐教。

回复内容：

最近在学习yii2,晃了几眼源代码，看到了类似怎样的注释：

<code>@ - 1

/**
 * User model
 *
 * @property integer $id
 * @property string $username
 * @property string $password_hash
 * @property string $password_reset_token
 * @property string $email
 * @property string $auth_key
 * @property integer $status
 * @property integer $created_at
 * @property integer $updated_at
 * @property string $password write-only password
 */

@ - 2

/**
 * @inheritdoc
 */
public static function tableName()
{
    return '{{%user}}';
}

@ - 3

/**
 * @var \common\models\User
 */</code>

登录后复制

不知道为什么要怎样写。求路过大神赐教。

这是符合phpdoc的注释格式，有很多工具可以解析这类注释并且直接生成文档，例如phpDocumentor, doxygen等等。IDE例如eclipse的PDT，InteliJ的IDEA和PHPStorm也能解析这种注释格式，并且根据注释来辅助生成代码提示

高级Bash脚本编程指南 chm版

这本书假定你没有任何关于脚本或一般程序的编程知识, 但是如果你具备相关的知识, 那么你将很容易就能够达到中高级的水平. . . 所有这些只是UNIX®浩瀚知识的一小部分. 你可以把本书作为教材, 自学手册, 或者是关于shell脚本技术的文档. 书中的练习和样例脚本中的注释将会与读者进行更好的互动, 但是最关键的前提是: 想真正学习脚本编程的唯一途径就是亲自动手编写脚本. 这本书也可作为教材来讲解一般的编程概念. 向伟大的中华民族的Linux用户致意! 我希望这本书能够帮助你们学习和理解L