{inheritdoc} 的需求是什么？

Question

我经常与 Drupal 和类打交道，有时我读到类似的内容：

/**
  * {@inheritdoc}
  */

  // return the form definition
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->config('hello_world.custom_salutation');

    $form['salutation'] = array(
      '#type' => 'textfield',
      '#title' => $this->t('Salutation'),
      '#description' => $this->t('Si prega di inserire il saluto che si desidera usare'),
      '#default_value' => $config->get('salutation'),
    );

继承的意思是什么？

Answer 1

它是一个docblock语法，是 Drupal 的API 文档和注释标准的一部分：

{@inheritdoc}您可以在课堂上使用

如果您要重写或实现基类或接口的方法，并且文档应与基类/接口方法完全相同

它还声明这必须是文档块中的唯一行。