“Kanca uygulamaları @param belgelerini çoğaltmamalıdır” nasıl düzeltilir?

10

Kodumu özel bir modülde temizlemeyi denemek için PhpStorm kullanıyorum. Aşağıdaki işlev için bu uyarıyı alıyorum:

Kanca uygulamaları @param belgelerini çoğaltmamalıdır.

/**
 * Implements hook_field_widget_form_alter().
 *
 * @param array $element
 * @param array $form_state
 * @param array $context
 */
function mymodule_field_widget_form_alter(&$element, $form_state, $context) {
  if ($context['widget'] instanceof \Drupal\text\Plugin\Field\FieldWidget\TextareaWidget) {
    $element['#after_build'][] = '_mymodule_remove_textarea_help';
  }
}

Bunu düzeltmek için ne yapmalıyım? @paramYorumları silmem gerektiğini düşündüm , ancak bunu yaptığımda PhpStorm herhangi bir param yorumum olmadığından şikayet ediyor.

coding-standards

— Patrick Kenny
kaynak

2

Belki "Tercihler -> Editör -> Denetimler -> PHP -> PHPDoc -> Eksik PHPDoc yorumu" kapalı? Genel cevap PHPStorm'un belge denetimlerinin Drupal'ın belge standartlarına uymasını sağlamaktır

— Clive

3

Sorun, drupal kodlama standartlarını ve php kodlama standartlarını kontrol etmenizdir.

— Sniffer'ı

@Clive burada doğru cevaba sahip. Bu hatanın kodlama standardı ile hiçbir ilgisi yoktur ve PHPStorm'un dahili denetimleriyle ilgili her şey :)

— Chapabu

Kabul edilen cevap verenler IDE'deki sorunu çözer, ancak kodlama standardını kontrol ederseniz sorun hala oradadır. Benim çözümüme bakın.

— Adrian Cid Almaguer

5

Sorun şu ki, bir kanca uyguluyorsanız ve bundan daha fazlasını yazmanız gerekmiyorsa:

/**
 * Implements hook_field_widget_form_alter().
 */

Çünkü hook_field_widget_form_alter()tanımdaki tüm bilgilere sahip olacaksınız , bu yüzden kanca uygulamalarına her zaman sadece şunu yazın:

/**
 * Implements hook_hook_name().
 */

Senin durumunda:

/**
 * Implements hook_field_widget_form_alter().
 */
function mymodule_field_widget_form_alter(&$element, $form_state, $context) {
  if ($context['widget'] instanceof \Drupal\text\Plugin\Field\FieldWidget\TextareaWidget) {
    $element['#after_build'][] = '_mymodule_remove_textarea_help';
  }
}

— Adrian Cid Almaguer
kaynak

2

Gelecek nesiller için bir cevap eklemek; Clive'nin yorumuna göre:

"Eksik PHPDoc Yorumları" olup olmadığını denetleyen yerleşik PHPStorm denetimini kapatmanız gerekir, ardından @parambloklarınızı güvenle silebilirsiniz .

— Chapabu
kaynak

1

Downvoter, cevabı değiştirebilmem için neyin yanlış olduğunu açıklamak ister mi? Yoksa sadece bir "tit for tat" aşağı oy mu?

— Chapabu

1

Bu IDE'deki sorunu çözer, ancak kodlama standardını kontrol ederseniz sorun hala oradadır. Benim çözümüme bakın.

— Adrian Cid Almaguer

0

Diğerlerinin söylediği gibi, projenizi Drupal projesi olarak değerlendirmek için PHPStorm yapılandırmasını ayarlamanız gerekir.

İkinci olarak, Coder ile çalışmaya başlayın .

Bu paketleri yükledikten sonra, PHPStorm'a bağlayabilir ve standart sisteminizi buna göre ayarlayabilir veya raporları komut satırından çalıştırabilirsiniz. Bu, ortamınızı PHPStorm ile kutu yapılandırması dışında gönderilen genel yerine Drupal kodlama standartlarıyla daha uyumlu hale getirecektir.

— Kevin
kaynak

1

Downvotes benim idi. Ben hiçbir şey "halı bomba" yoktu, ben sadece yanlış olarak cevapları aşağıya indirdi.

— Chapabu

2

Ne kaba bir davranış.

— Jimmy Ko