Nếu bạn đã từng thử đọc mã do người khác viết [ai chưa từng đọc?], thì bạn biết đó có thể là một nhiệm vụ khó khăn. Một mớ “mã spaghetti” trộn lẫn với vô số biến được đặt tên kỳ lạ khiến bạn quay cuồng. Chức năng này mong đợi một chuỗi hoặc một mảng?
PhpDoc, viết tắt của PhpDocumentor, là một công cụ mạnh mẽ cho phép bạn dễ dàng ghi lại mã của mình thông qua các nhận xét được định dạng đặc biệt. Tài liệu sẽ có sẵn không chỉ trong mã nguồn mà còn trong tài liệu chuyên nghiệp được trích xuất bằng web hoặc giao diện dòng lệnh. Kết quả có thể ở nhiều định dạng khác nhau như HTML, PDF và CHM. Ngoài ra, nhiều IDE cung cấp khả năng hoàn thành mã có thể phân tích các nhận xét PhpDoc và cung cấp các tính năng hữu ích như gợi ý kiểu. Bằng cách sử dụng PhpDoc, bạn có thể giúp người khác [và chính bạn] dễ dàng hiểu mã của bạn – hàng tuần, hàng tháng và thậm chí hàng năm sau khi bạn viết nó
Cách dễ nhất để cài đặt PhpDoc là với PEAR. Tất nhiên, trước khi bạn có thể làm như vậy, bạn phải cài đặt PEAR. Nếu không, hãy làm theo hướng dẫn tại lê. php. net/thủ công/vi/cài đặt. php
Trong bài viết này, tôi sẽ chỉ cho bạn cách sử dụng PhpDoc để tạo tài liệu tuyệt đẹp và thân thiện với người dùng từ đầu đến cuối
khối tài liệu
DocBlock là một nhận xét kiểu C nhiều dòng được sử dụng để ghi lại một khối mã. Nó bắt đầu bằng