{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'),
    );

Inheriteddoc是什么意思？

Answer 1

这是Drupal API documentation and comment standards的一部分的 docblock 语法：

您可以在课程中使用{@inheritdoc}

  

如果您要从基础覆盖或实现方法   类或接口，并且文档应该完全相同   作为基类/接口方法

它还指出，该必须是文档块中的唯一一行。