Information  Vous êtes sur mobile ou tablette ? Tenez votre appareil à l'horizontale !

Classes natives

Check PHPDoc


Cette classe permet de vérifier la qualité et la complétude de la documentation PHPDoc d'un fichier PHP (classe uniquement).

Démonstration :

Class bien documenté :

Array
(
    [file] => ./index.php
    [class] => website
    [valid] => 1
    [errors] => Array
        (
        )

)

Class mal documenté :

Array
(
    [file] => ./class/docPHP.class.php
    [class] => docPHP
    [valid] => 
    [errors] => Array
        (
            [0] => La classe n'a pas de PHPDoc.
            [1] => La propriété `_brush` n'a pas de PHPDoc.
            [2] => La méthode `__construct` n'a pas de PHPDoc.
            [3] => La méthode `introduction` n'a pas de PHPDoc.
            [4] => La méthode `nouveau_projet` n'a pas de PHPDoc.
            [5] => La méthode `configuration` n'a pas de PHPDoc.
            [6] => La méthode `pages` n'a pas de PHPDoc.
            [7] => La méthode `classes_metiers` n'a pas de PHPDoc.
            [8] => La méthode `methodes_evenementielles` n'a pas de PHPDoc.
            [9] => La méthode `entity` n'a pas de PHPDoc.
            [10] => La méthode `bdd` n'a pas de PHPDoc.
            [11] => La méthode `classes_natives` n'a pas de PHPDoc.
            [12] => La méthode `services_general` n'a pas de PHPDoc.
            [13] => La méthode `services_interne` n'a pas de PHPDoc.
            [14] => La méthode `CLI` n'a pas de PHPDoc.
            [15] => La méthode `WebSocket` n'a pas de PHPDoc.
            [16] => La méthode `mise_en_ligne` n'a pas de PHPDoc.
        )

)

exemple de classe dont la documentation est conforme :