Net Poradnik

Prawidłowe rozpoczęcie i zakończenie kodu php (kompatybilne również w przyszłości}:

<?php
// skrypt
?>

Komentarze PHP:

// - jedno liniowy

# - jedno liniowy

/* komentarz

wieloliniowy  */

Komentarze HTML:

<!-- komentarz 

         wieloliniowy -->

Komentarz CSS: 

/* komentarz 

wieloliniowy */

Komentarz phpDOC:                                       informacje zaciągnięte z http://4programmers.net/PHP/Dokumentacja_kodu_PHP

/**
 * Opis krótki
 *
 * Opis długi, Opis długi, Opis długi, Opis długi, Opis długi, Opis długi, Opis długi, 
 * Opis długi, Opis długi, Opis długi, Opis długi, Opis długi, Opis długi, Opis długi, 
 * 
 * @param string $a opis parametru
 * @param string $b opis parametru
 * @return bool Co otrzymujemy
 * @author Ktos <ktos@ktos.info>
 * @license http://www.example.com/gnugpl2/GNU GPL v2
 * @access public
 */

Dostępne znaczniki:

@abstract

Oznacza metodę, zmienną lub klasę, która musi być ponownie zdefiniowana w klasie potomnej.
Uwaga! Prawidłowe tylko dla PHP4, PHP5 posiada słowo kluczowe abstract.

@access

Kontrola dostępu do elementu. Jeśli używamy @access private to domyślnie phpDoc nie dołączy tego elementu do dokumentacji.

Dozwolone wartości: public, private, protected

@author

Oznacza autora elementu. Jeśli dodamy adres e-mail w nawiasach trójkątnych (na przykład: @author Joe Schmoe <jschmoe@example.com>) to phpDoc zamieni ten adres na klikalny link mailto.

@category

Znacznik kategorii używany jest do grupowania razem elementów @package rozproszonych po różnych plikach.

@copyright

Oznacza prawa autorskie do elementu.

@deprecated

Oznacza element przestarzały, który nie powinien być używany, jako, ze może zostać usunięty w następnych wersjach.

@final

Oznacza element, który nie powinien być nadpisywany przez klasy potomne.
Uwaga! Prawidłowe tylko dla PHP4, PHP5 posiada słowo kluczowe final.

@global

Definiuje zmienną globalną.

Są dwie metody użycia:

/**
 * @global typ_danych $nazwa_zmiennej
 * @global typ_danych opis zmiennej
 */

Typ danych musi być typem danych PHP albo mixed.

@ignore

Oznacza element ignorowany

@license

Wyświetla adres internetowy do dokumentu z licencją kodu.

Składnia: @license URL nazwa_licencji

@link

Tworzy hiperłącze do adresu internetowego.

Składnia:
@link URL
@link URL Tekst opisujący

Druga wersja uwtorzy link z opisem w postaci <a href=”URL”>Opis</a>.

@package

Grupuje razem klasy i funkcje.

@param

Oznacza parametr funkcji.

Składnia: @param typ_danych $nazwa_parametru Opis

@return

Określa typ danych zwracanych przez funkcję.

Składnia: @return typ_danych Opis

@since

Oznacza, od której wersji projektu jest w niej dany element.

@static

Oznacza metodę klasy jako statyczną (dostęp z zewnątrz bez tworzenia instancji klasy).

@staticvar

Oznacza zmienną klasy jako statyczną.

Składnia: @staticvar typ_danych Opis

@todo

Opis czynności, jakie zostały zaplanowane dla danego elementu, ale jeszcze nie wykonane.

@var

Opisuje zmienną.

Składnia: @var typ_danych Opis

@version

Opisuje wersję danego elementu.

Udostępnij na: