Hướng dẫn phpdocumentor tags - thẻ phpdocumentor

Show

Cách sử dụng thẻ trong docblocks

qua

Bản quyền 2002, Gregory Beaver

Hướng dẫn sử dụng thẻ

Chào mừng đến với Hướng dẫn sử dụng thẻ PHPDocumentor

Các thẻ PHPDocumentor rất giống với các thẻ cho công cụ Javadoc cho ngôn ngữ lập trình Java của Sun. Các thẻ chỉ được phân tích cú pháp nếu chúng là điều đầu tiên trên một dòng mới của một tài liệu. Bạn có thể sử dụng ký tự @ một cách tự do trong các tài liệu miễn là nó không bắt đầu một dòng mới. Một ví dụ:

  1. /**

  2.  * tags demonstration

  3.  * @author this tag is parsed, but this @version tag is ignored@author this tag is parsed, but this @version tag is ignored

  4.  * @version 1.0 this version tag is parsed@version 1.0 this version tag is parsed

  5.  */

Bất kỳ thẻ nào mà PhpDocomentor không nhận ra sẽ không được phân tích cú pháp và sẽ được hiển thị trong luồng văn bản như thể chúng là một phần của mô tả dài docblock. Ví dụ dưới đây hiển thị văn bản "Trình diễn thẻ @foobar Điều này thật ngớ ngẩn" và cũng hiển thị tác giả là "Thẻ này được phân tích cú pháp, nhưng thẻ @version này bị bỏ qua"

  1. /**

  2.  * tags demonstration

  3.  * @foobar this is silly@foobar this is silly

  4.  * @author this tag is parsed, but this @version tag is ignored@author this tag is parsed, but this @version tag is ignored

  5.  */

Bất kỳ thẻ nào mà PhpDocomentor không nhận ra sẽ không được phân tích cú pháp và sẽ được hiển thị trong luồng văn bản như thể chúng là một phần của mô tả dài docblock. Ví dụ dưới đây hiển thị văn bản "Trình diễn thẻ @foobar Điều này thật ngớ ngẩn" và cũng hiển thị tác giả là "Thẻ này được phân tích cú pháp, nhưng thẻ @version này bị bỏ qua"

Thẻ nội tuyến hiển thị trong luồng văn bản nơi chúng xuất hiện và không được tách ra khỏi mô tả. Kể từ phiên bản 1.2, có một số thẻ nội tuyến. Danh sách thẻ nội tuyến được phép là khác nhau cho các hướng dẫn và tài liệu trong mã thông thường. Xem các thẻ nội tuyến phpDocumentor để biết thêm thông tin.foo() to rule the world" where foo() represents a hyperlink that links to the function foo()'s documentation.

  1. /**

  2.  * inline tags demonstration

  3.  *

  4.  * this function works heavily with {@link foo()} to rule the world{@link foo()} to rule the world

  5.  */

  6. function bar()bar()

  7. Bất kỳ thẻ nào mà PhpDocomentor không nhận ra sẽ không được phân tích cú pháp và sẽ được hiển thị trong luồng văn bản như thể chúng là một phần của mô tả dài docblock. Ví dụ dưới đây hiển thị văn bản "Trình diễn thẻ @foobar Điều này thật ngớ ngẩn" và cũng hiển thị tác giả là "Thẻ này được phân tích cú pháp, nhưng thẻ @version này bị bỏ qua"

  8. Thẻ nội tuyến hiển thị trong luồng văn bản nơi chúng xuất hiện và không được tách ra khỏi mô tả. Kể từ phiên bản 1.2, có một số thẻ nội tuyến. Danh sách thẻ nội tuyến được phép là khác nhau cho các hướng dẫn và tài liệu trong mã thông thường. Xem các thẻ nội tuyến phpDocumentor để biết thêm thông tin.

  9. function foo()foo()

  10. Bất kỳ thẻ nào mà PhpDocomentor không nhận ra sẽ không được phân tích cú pháp và sẽ được hiển thị trong luồng văn bản như thể chúng là một phần của mô tả dài docblock. Ví dụ dưới đây hiển thị văn bản "Trình diễn thẻ @foobar Điều này thật ngớ ngẩn" và cũng hiển thị tác giả là "Thẻ này được phân tích cú pháp, nhưng thẻ @version này bị bỏ qua"

  11. Thẻ nội tuyến hiển thị trong luồng văn bản nơi chúng xuất hiện và không được tách ra khỏi mô tả. Kể từ phiên bản 1.2, có một số thẻ nội tuyến. Danh sách thẻ nội tuyến được phép là khác nhau cho các hướng dẫn và tài liệu trong mã thông thường. Xem các thẻ nội tuyến phpDocumentor để biết thêm thông tin.

Ví dụ dưới đây sẽ hiển thị văn bản "Hàm này hoạt động rất nhiều với foo () để thống trị thế giới" nơi foo () đại diện cho một siêu liên kết liên kết với tài liệu của hàm foo ().

{

  • @access

  • @author

  • @copyright

  • @deprecated

  • @example

  • @ignore

  • @internal

  • @link

  • @see

  • @since

  • @tutorial

  • @version

  • }

  • Thẻ PHPDocum số tiêu chuẩn

  • Hầu hết các thẻ có thể nằm trong tài liệu của bất kỳ phần tử PHP có thể ghi được nào (để biết định nghĩa về phần tử PHP có thể ghi lại, xem các phần tử PHP có thể ghi lại). Dưới đây là danh sách các thẻ tiêu chuẩn:


Cách sử dụng thẻ trong docblocks

bởi Gregory Beaver

Tài liệu thẻ được viết bởi
Bản quyền 2002, Gregory Beaver

Thẻ PHPDocum số tiêu chuẩn

Hầu hết các thẻ có thể nằm trong tài liệu của bất kỳ phần tử PHP có thể ghi được nào (để biết định nghĩa về phần tử PHP có thể ghi lại, xem các phần tử PHP có thể ghi lại). Dưới đây là danh sách các thẻ tiêu chuẩn:

  • @access

  • @author

  • @copyright

  • @deprecated

  • @example

  • @ignore

  • @internal

  • @link

  • @see

  • @since

  • @tutorial

  • @version

  • nội tuyến {@Internal}}

  • nội tuyến {@InHeritDoc}

  • nội tuyến {@link}