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

inheritdoc是什么意思？

Answer 1

这是一个 docblock 语法，是 Drupal 的 API documentation and comment standards 的一部分:

你可以在类中使用{@inheritdoc}

if you are overriding or implementing a method from a baseclass or interface, and the documentation should be exactly the sameas the base class/interface method

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