最近在学习yii2,晃了几眼源代码，看到了类似怎样的注释：
@ - 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
*/
不知道为什么要怎样写。求路过大神赐教。
回复内容：
最近在学习yii2,晃了几眼源代码，看到了类似怎样的注释：
@ - 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
*/
不知道为什么要怎样写。求路过大神赐教。
这是符合phpdoc的注释格式，有很多工具可以解析这类注释并且直接生成文档，例如phpDocumentor, doxygen等等。IDE例如eclipse的PDT，InteliJ的IDEA和PHPStorm也能解析这种注释格式，并且根据注释来辅助生成代码提示
@vimac 是正解，这是phpDoc的注释规范，和YII2无关。
详情楼主可以谷歌一下phpdoc，这样有利于各种IDE和编辑器对代码进行自动提示。YII APIDOC功能也是需要这个的。
