PHPDoctor

? PHPDOC TOR

Periksa file atau direktori PHP untuk jenis yang hilang.

Jika Anda sudah menggunakan phpstan untuk pemeriksaan tipe Anda, tetapi kadang -kadang seseorang dalam tim masih melakukan kode yang tidak diketik, maka phpDoctor adalah untuk Anda.

Instal melalui "Phar" ( disarankan )

https://github.com/voku/phpdoctor/releases

Instal melalui "composer membutuhkan"

composer require-dev voku/phpdoctor

Awal yang cepat

 Usage:
  analyse [options] [--] <path...>

Arguments:
  path                                                                                   The path to analyse

Options:
      --autoload-file[=AUTOLOAD-FILE]                                                    The path to your autoloader. [default: ""]
      --access[=ACCESS]                                                                  Check for "public|protected|private" methods. [default: "public|protected|private"]
      --skip-ambiguous-types-as-error[=SKIP-AMBIGUOUS-TYPES-AS-ERROR]                    Skip check for ambiguous types. (false or true) [default: "false"]
      --skip-deprecated-functions[=SKIP-DEPRECATED-FUNCTIONS]                            Skip check for deprecated functions / methods. (false or true) [default: "false"]
      --skip-functions-with-leading-underscore[=SKIP-FUNCTIONS-WITH-LEADING-UNDERSCORE]  Skip check for functions / methods with leading underscore. (false or true) [default: "false"]
      --skip-parse-errors[=SKIP-PARSE-ERRORS]                                            Skip parse errors in the output. (false or true) [default: "true"]
      --path-exclude-regex[=PATH-EXCLUDE-REGEX]                                          Skip some paths via regex e.g. "#/vendor/|/other/.*/path/#i" [default: "#/vendor/|/tests/#i"]

Demo

Parse string:

 $ code = '
<?php declare(strict_types = 1);   
     
class HelloWorld
{
    /**
     * @param mixed $date
     */ 
    public function sayHello($date): void
    {
        echo ' Hello, ' . $date->format( ' j. n. Y ' );
    }
} ' ;

$ phpdocErrors = PhpCodeChecker:: checkFromString ( $ code );

// [8]: missing parameter type for HelloWorld->sayHello() | parameter:date']

Abaikan kesalahan

Anda dapat menggunakan <phpdoctor-ignore-this-line/> di @param atau @return phpDocs untuk mengabaikan kesalahan secara langsung dalam kode Anda.

 /**
 * @param mixed $lall <p>this is mixed but it is ok, because ...</p> <phpdoctor-ignore-this-line/>
 *
 * @return array <phpdoctor-ignore-this-line/>
 */
function foo_ignore ( $ lall ) {
    return $ lall ;
}

Membangun File Phar

Persiapkan: https://github.com/phar-io/phive

phive install humbug/box
php tools/box compile --debug

Mendukung

Untuk dukungan dan sumbangan, silakan kunjungi GitHub | Masalah | Paypal | Patreon.

Untuk pembaruan status dan pengumuman rilis, silakan kunjungi rilis | Twitter | Patreon.

Untuk dukungan profesional, silakan hubungi saya.

Terima kasih

• Terima kasih kepada GitHub (Microsoft) yang telah menjadi tuan rumah kode dan infrastruktur yang baik termasuk isu-isu-managment, dll.
• Terima kasih kepada IntelliJ karena mereka membuat IDE terbaik untuk PHP dan mereka memberi saya lisensi open source untuk phpstorm!
• Terima kasih kepada Travis CI karena telah menjadi alat integrasi kontinous yang paling luar biasa dan termudah di luar sana!
• Terima kasih kepada Styleci untuk pemeriksaan gaya kode yang sederhana namun kuat.
• Terima kasih kepada Phpstan && Mazmur untuk alat analisis statis yang sangat bagus dan untuk Discover Bugs dalam kode!