2013-02-13 10 views
9

I zazwyczaj umieścić dokumentację w interfejsie jeśli mogę:See dziedziczone dokumentację w PHPStorm

interface SenderInterface 
{ 
    /** 
    * Sends Email to user 
    * 
    * @param UserInterface $receiver 
    * @param string $msg 
    */ 
    public function sendEmail(UserInterface $receiver, $msg) 
    //... 
    { 

I wtedy dziedziczyć doc tak aby uniknąć zwolnień.

class Sender implements SenderInterface 
{ 
    /** 
    * {@inheritDoc} 
    */ 
    public function sendEmail(UserInterface $receiver, $msg) 
    //... 
    { 

Czy istnieje sposób, aby zobaczyć odziedziczone doc bezpośrednio do Sender class bez konieczności otwierania SenderInterface w PHPStorm?

+1

Ale ... to już tak działa - przynajmniej w wersji EAP. Jaką masz wersję? – LazyOne

+0

Mam ostatnią wersję: PHPStorm 5.0.4. Właściwie szukam polecenia, dzięki czemu mogę zobaczyć dokumentację bezpośrednio w klasie nadawców bez konieczności otwierania klasy interfejsu. Nie chcę też używać generatora dokumentów API ... Może jest jakieś polecenie wewnątrz PHPS, aby wyświetlić dziedziczony dokument? – Mick

+0

Działa w ** EAP ** kompilacji ** v6 ** - możesz ją wypróbować samodzielnie na http://confluence.jetbrains.net/display/WI/Web+IDE+EAP. Polecenie do przeglądania dokumentacji to ** Wyświetl | Szybka dokumentacja ** (Ctrl + Q .. lub jakikolwiek skrót, jaki możesz tam mieć) – LazyOne

Odpowiedz

12

Nadchodzący PhpStorm v6 ma znacznie lepsze wsparcie {@inheritDoc} (w porównaniu do v5 i wcześniej).

Funkcjonalność wymagają już działa dobrze w EAP kompilacji (Early Access Program) - można spróbować samemu stąd: http://confluence.jetbrains.net/display/WI/Web+IDE+EAP

poleceń aby dokumentacja jest View | Szybka dokumentacja (Ctrl + Q .. lub jakikolwiek skrót, który tam możesz mieć)

+3

F1 na OSX, dla v8 – Ascherer

+2

Czy IDE faktycznie nie renderuje odziedziczonego dokumentu w klasie? Byłoby to o wiele bardziej pomocne niż naciskanie F1 na każdą metodę. –