2015-05-27 21 views
13

Mam skonfigurować inspekcję kodu dla bloków php doc, więc teraz otrzymam ostrzeżenie, jeśli brakuje lub są niekompletne.Jak zaktualizować i wygenerować DocBlock dla całego projektu w PhpStorm?

Code inspection for PHPDoc

Kiedy mam jedna klasa otwarta, można użyć Code > Generate > PhpDocBlocks wygenerować je lub po prostu rozpocząć komentarz poprzez /* przed metody i zostanie on dodany.

Ponadto, jeśli bloki doc są niekompletne lub błędne, mogę użyć Update DocBlock, aby dopasować DocBlock metody do faktycznego podpisu metody.

Czy istnieje sposób ich zastosowania, zarówno generowanie bloku dokumentów, jak i, jeśli to konieczne, aktualizacja bloku dokumentacyjnego przez całą bazę kodów bez ręcznego inicjowania tego w każdej klasie?

Szukam procesu wsadowego.

Odpowiedz

20

W widoku projektu można kliknąć prawym przyciskiem myszy folder i wybrać opcję Inspect Code. Jest również dostępny przez Code > Inspect Code.

Pojawi się okno z prośbą o dalsze szczegóły, a także możesz oczekiwać zakresu w całym kontekście.

Upewnij się, że Twój Profil inspekcji zawiera PHPDoc. Jeżeli inspekcja ma przebiegać przez, wtedy będzie miał sekcję PHPDoc,

Result of Code Inspection

klikając prawym przyciskiem myszy następnie może Apply Fix nawet dla wielu klas.

5

Sprawdź ten screenshot: enter image description here

można przeczytać więcej na temat tworzenia docs here

+1

To generuje tylko bloku dokumentacyjnym w obecnej klasie. Pytanie dotyczy wszystkich klas w całym projekcie. – k0pernikus