2017-06-21 1 views
0

Ich mag PhpStorm und seinen Dokumentgenerator nach phpDoc. Jetzt kämpfe ich mit Rückgabetyp in schneller Dokumentation. Zum Beispiel habe ich diesen Code:PhpStorm - Rückgabetyp Hinweise in schneller Dokumentation

$import_type = $this->importContainer->getType()->getSelectedSchema(); 

und in ImportContainer Klasse Ich habe diese getType Methode:

/** 
* @return \Easyk\inout\InOutImportType 
*/ 
public function getType() { 
    return $this->type; 
} 

Alles funktioniert gut, aber wenn ich PhpStorm die schnelle Dokumentation verwenden möchten werde ich sehen:

quick documentation

Und es gibt keinen Rückgabewert, was \Easyk\inout\InOutImportType von re sein sollte Typhinweis. Ich fand, dass, wenn ich diese Art Hinting haben:

/** 
* @return \Easyk\inout\InOutImportType $importType 
*/ 

dann werde ich Rückgabewert siehe:

enter image description here

Nach phpDoc documentation in @return Syntax Beschreibung optional, also warum sollte ich Rückkehr beschreiben Wert, um es in der schnellen Dokumentation zu sehen? Für mich wäre es am besten, wenn Sie in der schnellen Dokumentation genau die Art des Rückgabetyps sehen - ohne Beschreibung. Ich habe keine Option in PhpStorm gefunden, um es zu aktivieren, gibt es eine Workaround oder ich vermisse etwas und mache es falsch?

Ich verwende 2017.01.04 PhpStorm

Antwort

4

... oder ich etwas vermissen und es falsch?

Nein - es funktioniert schon.

Und es gibt keinen Rückgabewert, was \Easyk\inout\InOutImportType von Rückgabetyp Hinting sein sollte.

Es ist da - wieder überprüfen (Hinweis: Überprüfung der 1. Zeile dort - Funktion Unterschrift/Erklärung).


Was Sie in „Returns“ Abschnitt sehen, ist die optional (wie Sie selbst bemerkt haben) Beschreibung/Erklärung des Rückgabewerts (zum Beispiel „Gibt die Anzahl der Elemente oder FALSE bei einem Fehler“).

Die tatsächlichen Rückgabetypen sind am Ende der Funktionssignatur in der ersten Zeile aufgeführt.

+0

Vielen Dank, ich habe diese Funktionssignatur verpasst und ich habe sie im Gegenzug erwartet. –

Verwandte Themen