@agent1156

Как писать комментарии в yii2?

Что означают такого рода комментарии /**
* @inheritdoc
*/ и как их ставить в своем коде в phpstorm ???

/**
 * This is the model class for table "img".
 *
 * @property integer $id
 * @property string $category
 * @property string $url
 * @property string $description
 * @property string $alt
 */
class Img extends \yii\db\ActiveRecord
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return 'img';
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['category', 'url', 'description', 'alt'], 'required'],
            [['category', 'url', 'description', 'alt'], 'string', 'max' => 255],
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'id' => 'ID',
            'category' => 'Category',
            'url' => 'Url',
            'description' => 'Description',
            'alt' => 'Alt',
        ];
    }
}
  • Вопрос задан
  • 305 просмотров
Пригласить эксперта
Ответы на вопрос 1
Decadal
@Decadal
yii2 тут ни при чём.

Всё зависит от того, каким редактором или IDE пользовался автор кода - обычно там свои встроенные генераторы для комментариев. Например, PhpStorm использует https://www.phpdoc.org/ - этот стандарт.
@inheritdoc - согласно стандарту, отсылка к документации родительского класса.
ставить так - перед функцией или переменной нажимаете три клавиши: /** , затем ENTER
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы