關於注釋的寫法與疑問

最近在學習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無關。

詳情樓主可以Google一下phpdoc，這樣有利於各種IDE和編輯器對代碼進行自動提示。YII APIDOC功能也是需要這個的。

