Unduhan phpDocumentor - pengunduhan kode sumber phpDocumentor

phpDocumentor

Kategori lainnya

v3.5.3

Unduh

phpDokumentor

Apa itu phpDocumentor?

phpDocumentor berdiri sebagai alat dokumentasi de-facto untuk proyek PHP, menawarkan solusi tangguh untuk menghasilkan dokumentasi komprehensif dengan mudah. Dengan menganalisis kode sumber PHP dan komentar DocBlock Anda, phpDocumentor menghasilkan serangkaian dokumentasi API yang lengkap, menjadikannya alat yang sangat diperlukan bagi pengembang yang berupaya mendapatkan basis kode yang jelas dan terdokumentasi dengan baik.

Selain kehebatannya dalam dokumentasi API, phpDocumentor melangkah lebih jauh dengan menyediakan fitur tambahan. Ia dilengkapi dengan kemampuan untuk membuat diagram UML, menjadikannya alat serbaguna untuk memvisualisasikan struktur kode. Selain itu, phpDocumentor menawarkan parser bahasa markup berfitur lengkap, mendukung sintaks RestructuredText dan Markdown. Fleksibilitas ini memungkinkan Anda mendokumentasikan proyek Anda menggunakan bahasa markup yang paling sesuai dengan preferensi Anda.

Fitur penting dari phpDocumentor adalah kemampuannya untuk memasukkan bagian dokumentasi API Anda langsung ke dalam dokumentasi RestructuredText Anda. Integrasi ini memastikan dokumentasi dan kode Anda tetap sinkron, sehingga menghemat waktu dan tenaga Anda dalam memelihara dokumentasi proyek yang akurat dan terkini.

Terinspirasi oleh pendahulunya, phpDocumentor 1 dan JavaDoc, phpDocumentor terus berinovasi, selalu mengikuti perkembangan teknologi terkini dan fitur bahasa PHP. Komitmen ini memastikan bahwa pengembang memiliki akses terhadap pengalaman dokumentasi terbaik, selaras dengan praktik pembangunan modern.

Dalam panduan ini, kita akan menjelajahi berbagai fitur phpDocumentor, mulai dari fungsi intinya dalam menghasilkan dokumentasi API hingga kemampuan tingkat lanjut dalam mengurai bahasa markup. Baik Anda seorang pemula atau pengembang berpengalaman, phpDocumentor adalah sekutu Anda dalam membuat proyek PHP yang terdokumentasi dengan baik, mudah dipelihara, dan mudah dipahami.

phpDocumentor v3 (Stabil)

v3 adalah rilis stabil terbaru.

Dokumentasi

Untuk informasi lebih detail, Anda dapat memeriksa dokumentasi online kami di https://docs.phpdoc.org/.

Fitur

phpDocumentor mendukung hal berikut:

Kompatibel dengan PHP 7.0+ , dukungan penuh untuk Namespace, Penutupan, dan lainnya disediakan.
Docblock daripada tipe , docblock bisa lebih eksplisit tentang tipe tidak semua format didukung oleh php asli.
Menampilkan tag apa pun , beberapa tag menambahkan fungsionalitas tambahan ke phpDocumentor (seperti @link).
Penggunaan memori rendah , penggunaan memori puncak untuk proyek kecil kurang dari 20MB, proyek menengah 40MB, dan kerangka kerja besar 100MB.
Penguraian tambahan , jika Anda menyimpan file Struktur dari proses sebelumnya, Anda mendapatkan peningkatan kinerja tambahan hingga 80% selain peningkatan kecepatan pemrosesan yang disebutkan di atas.
Pembuatan template mudah , jika ingin membuat branding hanya perlu memanggil 1 tugas dan mengedit 3 file.
Proses dua langkah , phpDocumentor terlebih dahulu membuat cache dengan struktur aplikasi Anda sebelum membuat hasilnya. Jika mau, Anda dapat menggunakannya untuk memberi daya pada alat atau pemformat Anda sendiri!
Dukungan generik , dengan analisis yang lebih statis dalam tipe php menjadi lebih kompleks. phpDocumentor memahami jenis ini. Dan akan menjadikannya sebagai tipe kelas satu.

Instalasi

PhpDocumentor memerlukan PHP 8.1 atau lebih tinggi untuk dijalankan. Namun, kode versi PHP sebelumnya dapat dianalisis.

Semua templat yang disediakan dengan phpDocumentor memiliki dukungan untuk diagram Kelas berdasarkan basis kode baca. Ini memerlukan aplikasi [PlantUml] untuk diinstal pada mesin yang menjalankan phpDocumentor. Merender diagram kelas menggunakan [PlantUml] adalah opsional, dan peringatan tentang hilangnya [PlantUml] dapat diabaikan. Namun, dokumentasi Anda akan berisi beberapa tautan mati dalam kasus ini. Diagram kelas akan dibuat dengan opsi --setting=graphs.enabled=true .

Ada 4 cara untuk menginstal phpDocumentor:

Menggunakan phive (disarankan)
Menggunakan PHAR (instal manual)
Melalui Docker
Melalui Komposer

Menggunakan Phive

$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42

Untuk informasi lebih lanjut tentang phive lihat situs web mereka. Sekarang Anda telah menginstal phpDocumentor, dapat dijalankan seperti ini:

php tools/phpDocumentor

Menggunakan PHAR

Unduh file phar dari https://github.com/phpDocumentor/phpDocumentor/releases
Anda dapat menjalankan phar seperti ini: php phpDocumentor.phar

Melalui Docker

$ docker pull phpdoc/phpdoc
$ docker run --rm -v $(pwd):/data phpdoc/phpdoc

Melalui Komposer (tidak disarankan)

Tapi tunggu? Bagaimana dengan komposer?

Ah, kamu menemukan rahasia kami. Ada paket komposer phpdocumentor yang dapat Anda gunakan untuk menginstal phpDocumentor.

Namun: phpDocumentor adalah aplikasi yang kompleks, dan perpustakaannya digunakan di banyak perpustakaan dan aplikasi lain (2 perpustakaan kami masing-masing memiliki lebih dari 150 juta unduhan); dan ini berarti kemungkinan terjadinya konflik antara salah satu ketergantungan kami dan ketergantungan Anda tinggi. Dan ketika saya bilang tinggi, itu sangat tinggi.

Jadi, karena hal di atas: kami tidak mendukung atau secara aktif mendukung instalasi phpDocumentor menggunakan Composer.

Bagaimana cara menggunakan phpDocumentor?

Cara termudah untuk menjalankan phpDocumentor adalah dengan menjalankan perintah berikut:

$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>

Perintah ini akan mengurai kode sumber yang disediakan menggunakan argumen -d dan mengeluarkannya ke folder yang ditunjukkan oleh argumen -t .

phpDocumentor mendukung berbagai opsi untuk mengonfigurasi keluaran dokumentasi Anda. Anda dapat menjalankan perintah berikut, atau memeriksa situs web kami, untuk daftar opsi baris perintah yang tersedia lebih detail.

$ phpdoc run -h

File konfigurasi

phpDocumentor juga mendukung penggunaan file konfigurasi (bernama phpdoc.xml atau phpdoc.dist.xml secara default). Silakan lihat dokumentasi untuk melihat format dan opsi yang didukung.

Bangunan malam

PhpDocumentor tidak memiliki rilis malam. Namun, di setiap jalur pipa, artefak phar dibuat. Jika Anda ingin menguji phpDocumentor versi terbaru, lihat bagian tindakan di repositori ini. Setiap alur kerja QA yang berhasil memiliki bagian Artefak di bagian bawah dengan artefak phar yang dibuat.