Làm cách nào để cài đặt phpDocumentor?

Trong các bài đăng trước, tôi đã nói về Tiêu chuẩn mã hóa WordPress và tầm quan trọng của việc ghi lại mã của bạn, nhưng tôi chưa thực sự dành nhiều thời gian để thảo luận về việc tạo tài liệu cho chủ đề của bạn dễ dàng như thế nào

Và theo tài liệu, ý tôi là một trang web thực cung cấp DocBlocks của bạn theo kiểu sạch sẽ và có tổ chức – bạn biết đấy, các trang web được tạo bởi các công cụ như phpDocumentor

Một ví dụ về trang web được tạo bởi phpDocumentor

Trong các bài đăng khác, tôi đã đề cập rằng tôi sử dụng MAMP Pro cho một phần trong ngăn xếp phát triển của mình, vì vậy nếu bạn đang tìm kiếm các bước để cài đặt phpDocumentor, thì thực sự rất dễ thực hiện

Cài đặt phpDocumentator

Trước khi cài đặt phpDocumentor, điều quan trọng cần lưu ý là phiên bản PHP nào bạn thường chạy khi làm việc với MAMP. Vì tôi làm hầu hết công việc của mình với WordPress và WordPress hỗ trợ các phiên bản PHP cũ hơn nên tôi thường treo lại một số phiên bản vì lý do tương thích

Cụ thể, tôi chạy với 5. 3. 28 trên máy của tôi. Bất kể bạn sử dụng cái gì, chỉ cần ghi lại vì bạn sẽ cần đến nó trong giây lát

1. Điều hướng đến Cài đặt PHP của bạn

Đối với tôi, PHP nằm trong thư mục sau

/Applications/MAMP/bin/php/php5.3.28/bin

Vì vậy, bằng cách sử dụng một thiết bị đầu cuối, tôi sẽ điều hướng đến thư mục đó

2. Thêm Kênh PHPDoc

Tiếp theo, sử dụng Pear để khám phá kênh PHPDoc – cảm ơn giúp cài đặt thực sự dễ dàng. Để thực hiện việc này, hãy nhập lệnh sau vào terminal

./pear channel-discover pear.phpdoc.org

Sau khi làm điều đó, bạn sẽ thấy một thông báo thành công. Nếu tại một thời điểm nào đó trong quá khứ, bạn đã thêm kênh này hoặc kênh này đã được đưa vào thông qua một số công cụ khác, thì bạn có thể thấy thông tin sau

Kênh “lê. phpdoc. org” đã được khởi tạo

Bất kể, bạn sẽ ổn để cài đặt

3. Chạy cài đặt

Chạy cài đặt dễ dàng như ban hành lệnh sau

./pear install phpdoc/phpDocumentor

Tại thời điểm này, bạn sẽ nhận thấy thiết bị đầu cuối đang tải xuống gói, thiết lập gói và tất cả những thứ thú vị đó. Nhưng có một vấn đề. Nếu bạn muốn chạy phpDoc trên mã, chẳng hạn, nằm ở nơi khác trong hệ thống của bạn (có thể là như vậy), thì bạn có thể muốn thiết lập một liên kết tượng trưng để không phải nhập đường dẫn đầy đủ tới phpDoc

4. Tạo một liên kết tượng trưng

Để tạo một liên kết tượng trưng, ​​hãy nhớ lại phiên bản PHP từ phần trước của bài viết này (hãy nhớ rằng tôi đang sử dụng 5. 3. 28) và sau đó nhập thông tin sau vào thiết bị đầu cuối

sudo ln -s /Applications/MAMP/bin/php/php5.3.28/bin/phpdoc /usr/bin/phpdoc

Điều này sau đó sẽ làm cho lệnh phpDoc có sẵn ở bất cứ đâu trong hệ thống tệp của bạn để bạn có thể dễ dàng tạo tài liệu cho các dự án của mình

5. Tạo tài liệu

Tại thời điểm này, tất cả những gì còn lại phải làm là thực sự tạo tài liệu. Vì vậy, ví dụ: giả sử tôi có một plugin trong wp-content/plugins/acme-plugin và tôi muốn tạo tài liệu cho nó

Để làm điều đó, tôi sẽ điều hướng đến thư mục trên sau đó đưa ra lệnh sau

/Applications/MAMP/bin/php/php5.3.28/bin/phpdoc -d ./ -t ./docs

Điều này sẽ tạo tài liệu cho plugin trong thư mục gốc của plugin. Bạn có thể tải nó lên trong trình duyệt của mình và xem qua

Lựa chọn khác

Tất nhiên, có nhiều thứ bạn có thể làm với phpDocumentor chẳng hạn như chọn chủ đề, thay đổi một số hoặc đối số, v.v. Nhưng bạn có thể đọc thêm về điều đó trong tài liệu của nó

Gói này đã được thay thế, nhưng vẫn được duy trì để sửa lỗi và bảo mật. Gói đã chuyển đến kênh lê. phpdoc. tổ chức, gói phpdocumentor

» Tóm tắt» Giấy phép Gói phpDocumentor cung cấp tài liệu tự động về api php trực tiếp từ nguồn. LGPL» Bản phát hành hiện tại» Tóm tắt lỗi1. 5. 0a1 (alpha) đã được phát hành vào ngày 2012-09-02 bởi ashnazg (Changelog)

Dễ cài đặt

Không chắc?

lê cài đặt PhpDocumentor

Cài đặt Kim tự tháp

Hãy thử trình cài đặt của PEAR2, Pyrus

kim tự tháp php. phar cài đặt quả lê/PhpDocumentor

1. 4. 4 (ổn định) được phát hành vào ngày 2011-12-03 (Nhật ký thay đổi)
Lộ trình phát triển

• Xếp hạng bảo trì gói. 26 trong số 231 gói có lỗi mở
• Số lỗi mở. 1 (tổng cộng 165 lỗi)
• Tuổi trung bình của lỗi mở. 1980 ngày
• Lỗi mở cũ nhất. 1980 ngày

Báo cáo lỗi mới cho PhpDocumentor» Mô tảCông cụ phpDocumentor là một tài liệu tự động độc lập tương tự như JavaDoc
được viết bằng PHP. Nó khác với PHPDoc ở chỗ nó nhanh hơn RẤT NHIỀU, phân tích cú pháp
phạm vi tệp php rộng hơn nhiều và đi kèm với nhiều tùy chỉnh bao gồm 11 mẫu HTML
, trợ giúp về cửa sổ . Ngoài ra, nó có thể làm nổi bật và liên kết mã nguồn PHPXref
output for use with documenting PEAR. In addition, it can do PHPXref source
.

Tính năng (danh sách ngắn).
-đầu ra ở dạng HTML, PDF (trực tiếp), CHM (với trình biên dịch trợ giúp của windows), XML DocBook
-rất nhanh
.
-fully customizable output with Smarty-based templates
-recognizes JavaDoc-style documentation with special tags customized for PHP 4
-automatic linking, class inheritance diagrams and intelligent override
-customizable source code highlighting, with phpxref-style cross-referencing
-parses standard README/CHANGELOG/INSTALL/FAQ files and includes them
directly in documentation
-generates a todo list from @todo tags in source
-generates multiple documentation sets based on @access private, @internal and
{@internal} tags
-example php files can be placed directly in documentation with highlighting
and phpxref linking using the @example tag
-linking between external manual and API documentation is possible at the
sub-section level in all output formats
-easily extended for specific documentation needs with Converter
-full documentation of every feature, manual can be generated directly from
the source code with "phpdoc -c makedocs" in any format desired.
-hướng dẫn sử dụng hiện tại luôn có sẵn tại http. //www. phpdoc. tổ chức/thủ công. php
-người dùng. ini có thể được sử dụng để kiểm soát đầu ra, nhiều đầu ra có thể được
tạo cùng một lúc

**CẢNH BÁO**.
Để sử dụng giao diện web, bạn phải đặt data_dir của PEAR thành thư mục con của
tài liệu gốc.

Nếu duyệt đến http. //máy chủ cục bộ/chỉ mục. php hiển thị/đường dẫn/đến/htdocs/index. php,
đặt data_dir thành thư mục con của /path/to/htdocs.

$pea config-set data_dir /path/to/htdocs/pear
$pea cài đặt PhpDocumentor

http. //localhost/pear/PhpDocumentor là giao diện web

» Người bảo trì» Thêm thông tin

---

Các gói phụ thuộc vào PhpDocumentor

Phụ thuộc cho PhpDocumentor

Làm cách nào để chạy PhpDocumentor?

Làm cách nào để tạo PHPDoc?

Tại sao nên sử dụng PHPDoc?