Hướng dẫn phpdoc array of arrays - mảng phpdoc của mảng

Question

Nói rằng tôi có một chức năng như thế này:

function theFunction() {
    $arr = array();
    for ($i=0;$i<10;$i++) {
        $arr[] = new theObject($i);
    }
    return $arr;
}

Tôi cần ghi lại loại trả về của hàm. Tất nhiên tôi có thể chỉ sử dụng ____55, nhưng điều đó không cung cấp tất cả thông tin có thể được cung cấp và không nói với nhà phát triển nhiều về bản chất thực sự của hàm.

Làm cách nào để ghi lại loại "mảng của [type]" trong PHPDOC?

Mogsdad

43,8K20 Huy hiệu vàng148 Huy hiệu bạc268 Huy hiệu Đồng20 gold badges148 silver badges268 bronze badges

Đã hỏi ngày 11 tháng 6 năm 2013 lúc 11:06Jun 11, 2013 at 11:06

4

Từ tài liệu của PhpDocumentor

Giá trị được biểu diễn theo loại có thể là một mảng. Loại phải được xác định theo định dạng của một trong các tùy chọn sau:
Không xác định, không có định nghĩa về nội dung của mảng được biểu thị được đưa ra. Ví dụ: @return array, no definition of the contents of the represented array is given. Example: @return array
Được chỉ định chứa một loại duy nhất, định nghĩa loại thông báo cho người đọc về loại của mỗi phần tử mảng. Chỉ có một loại sau đó được mong đợi là phần tử cho một mảng nhất định., the Type definition informs the reader of the type of each array element. Only one Type is then expected as element for a given array.
Ví dụ: @return int[]
Xin lưu ý rằng hỗn hợp cũng là một loại duy nhất và với từ khóa này, có thể chỉ ra rằng mỗi phần tử mảng chứa bất kỳ loại có thể nào.
Được chỉ định chứa nhiều loại, định nghĩa loại thông báo cho người đọc về loại của mỗi phần tử mảng. Mỗi yếu tố có thể thuộc bất kỳ loại đã cho. Ví dụ: @return (int|string)[], the Type definition informs the reader of the type of each array element. Each element can be of any of the given types. Example: @return (int|string)[]
Lưu ý nhiều IDE có thể chưa hỗ trợ ký hiệu này.
many IDEs probably do not support this notation yet.

Hướng dẫn phpdoc array of arrays - mảng phpdoc của mảng

Pang

9.264146 Huy hiệu vàng85 Huy hiệu bạc120 Huy hiệu đồng146 gold badges85 silver badges120 bronze badges

Đã trả lời ngày 11 tháng 6 năm 2013 lúc 11:12Jun 11, 2013 at 11:12

RobertrobertRobert

Huy hiệu vàng 19.3k555 Huy hiệu bạc83 Huy hiệu đồng5 gold badges55 silver badges83 bronze badges

2

Trong PHPDOC, bạn có thể làm như sau cho các thành viên Mảng Gõ:

@var array<\My\Folder\ClassName>

CẬP NHẬT

Bạn cũng có thể khai báo rõ ràng chìa khóa cho các mảng kết hợp như sau:

@var array

Và theo câu trả lời được đăng ở đây, bạn thậm chí có thể khai báo rõ ràng các khóa trong trường hợp bạn muốn làm như vậy như thế này:

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

Lưu ý: Điều này được thử nghiệm và hoạt động hoàn toàn tốt trong Php Storm: This is tested and works perfectly well in PHP storm:

Đã trả lời ngày 8 tháng 4 năm 2015 lúc 12:29Apr 8, 2015 at 12:29

WiltwiltWilt

38.8K12 Huy hiệu vàng142 Huy hiệu bạc197 Huy hiệu đồng12 gold badges142 silver badges197 bronze badges

7

Nếu tôi nhớ đúng, bạn cung cấp loại trả lại và mô tả, bạn có thể không đặt nó vào mô tả không?

/**
 * blah
 * @return array array of types
 */

Đã trả lời ngày 11 tháng 6 năm 2013 lúc 11:11Jun 11, 2013 at 11:11

DaledaleDale

10.3k20 Huy hiệu bạc34 Huy hiệu đồng20 silver badges34 bronze badges

1

```
@var array
```
7
Installing/Configuring
- Dragos Dot Rusu tại Nospam Dot bytex dot ro ¶
- 12 năm trước
- Thông tin tại Curtinsnospamcreactions dot com ¶
- Sunear tại gmail dot com ¶

/**
 * blah
 * @return array array of types
 */

1

Andyd273 tại Gmail Dot Com ¶
web tại houhejie dot cn ¶
- 4 năm trước
- Array_chunk - Chia một mảng thành các khối
- Array_Column - Trả về các giá trị từ một cột duy nhất trong mảng đầu vào
- Array_Combine - Tạo một mảng bằng cách sử dụng một mảng cho các phím và một mảng khác cho các giá trị của nó
- mảng_count_values - đếm tất cả các giá trị của một mảng
- Array_Diff_assoc - Tính toán sự khác biệt của mảng với kiểm tra chỉ mục bổ sung
- Array_Diff_Key - Tính toán sự khác biệt của các mảng sử dụng các khóa để so sánh
- Array_Diff_Uassoc - Tính độ khác biệt của các mảng với kiểm tra chỉ mục bổ sung được thực hiện bởi chức năng gọi lại do người dùng cung cấp
- Array_Diff_ukey - Tính độ khác biệt của các mảng bằng hàm gọi lại trên các phím để so sánh
- mảng_diff - tính toán sự khác biệt của mảng
- Array_Fill_Keys - Điền vào một mảng với các giá trị, chỉ định các khóa
- Array_Fill - Điền một mảng với các giá trị
- Array_Filter - Lọc các thành phần của một mảng bằng hàm gọi lại
- Array_flip - Trao đổi tất cả các khóa với các giá trị liên quan của chúng trong một mảng
- Array_intersect_assoc - Tính toán giao điểm của các mảng bằng kiểm tra chỉ mục bổ sung
- Array_intersect_key - Tính toán giao điểm của các mảng bằng các phím để so sánh
- Array_intersect_uassoc - Tính toán giao điểm của các mảng bằng kiểm tra chỉ mục bổ sung, so sánh các chỉ mục bằng hàm gọi lại
- Array_intersect_ukey - Tính toán giao điểm của các mảng bằng hàm gọi lại trên các phím để so sánh
- Array_Intersect - Tính toán giao điểm của mảng
- Array_is_List - Kiểm tra xem một mảng nhất định có phải là danh sách không
- Array_Key_Exists - Kiểm tra xem phím hoặc chỉ mục đã cho có tồn tại trong mảng không
- Array_Key_First - Nhận khóa đầu tiên của một mảng
- Array_Key_Last - Nhận khóa cuối cùng của một mảng
- Array_Keys - Trả lại tất cả các phím hoặc một tập hợp con của các phím của một mảng
- Array_Map - Áp dụng cuộc gọi lại cho các phần tử của các mảng đã cho
- Array_merge_Recursive - Hợp nhất một hoặc nhiều mảng
- mảng_merge - hợp nhất một hoặc nhiều mảng
- Array_Multisort-Sắp xếp nhiều mảng hoặc đa chiều
- mảng_pad - mảng pad đến độ dài được chỉ định với giá trị
- mảng_pop - bật phần tử ra khỏi phần cuối của mảng
- Array_Product - Tính toán sản phẩm của các giá trị trong một mảng
- Array_Push - Đẩy một hoặc nhiều phần tử vào cuối Array
- Array_rand - Chọn một hoặc nhiều phím ngẫu nhiên từ một mảng
- Array_Reduce - lặp đi lặp lại mảng thành một giá trị duy nhất bằng cách sử dụng hàm gọi lại
- Array_Replace_Recursive - Thay thế các phần tử từ các mảng được truyền vào mảng đầu tiên đệ trình
- Array_Repace - Thay thế các phần tử từ các mảng được truyền vào mảng đầu tiên
- Array_Reverse - Trả về một mảng với các phần tử theo thứ tự ngược lại
- Array_Search - Tìm kiếm mảng cho một giá trị đã cho và trả về khóa tương ứng đầu tiên nếu thành công
- Array_Shift - Chuyển một phần tử ra khỏi đầu mảng
- Array_Slice - Trích xuất một lát của mảng
- Array_Splice - Xóa một phần của mảng và thay thế nó bằng một cái gì đó khác
- Array_Sum - Tính tổng các giá trị trong một mảng
- Array_udiff_assoc - Tính chênh lệch của mảng với kiểm tra chỉ mục bổ sung, so sánh dữ liệu bằng hàm gọi lại
- Array_udiff_uassoc - Tính độ khác biệt của các mảng với kiểm tra chỉ mục bổ sung, so sánh dữ liệu và chỉ mục bằng hàm gọi lại
- Array_udiff - Tính độ khác biệt của các mảng bằng cách sử dụng chức năng gọi lại để so sánh dữ liệu
- Array_uintersect_assoc - Tính toán giao điểm của các mảng bằng kiểm tra chỉ mục bổ sung, so sánh dữ liệu bằng hàm gọi lại
- Array_uintersect_uassoc - Tính toán giao điểm của các mảng bằng kiểm tra chỉ mục bổ sung, so sánh dữ liệu và chỉ mục bằng các hàm gọi lại riêng biệt
- Array_uintersect - Tính toán giao điểm của mảng, so sánh dữ liệu bằng hàm gọi lại
- Array_unique - Xóa các giá trị trùng lặp khỏi một mảng
- Array_Unshift - Đủ một hoặc nhiều yếu tố cho đầu một mảng
- Array_Values - Trả về tất cả các giá trị của một mảng
- Array_Walk_Recursive - Áp dụng chức năng người dùng đệ quy cho mọi thành viên của một mảng
- Array_Walk - Áp dụng chức năng do người dùng cung cấp cho mọi thành viên của một mảng
- Mảng - Tạo một mảng
- Arsort - Sắp xếp một mảng theo thứ tự giảm dần và duy trì hiệp hội chỉ số
- ASORT - Sắp xếp một mảng theo thứ tự tăng dần và duy trì liên kết chỉ số
- Compact - Tạo mảng chứa các biến và giá trị của chúng
- Đếm - Đếm tất cả các phần tử trong một mảng hoặc trong một đối tượng có thể đếm được
- hiện tại - Trả về phần tử hiện tại trong một mảng
- Mỗi - trả về cặp khóa và giá trị hiện tại từ một mảng và tiến lên con trỏ mảng
- Kết thúc - Đặt con trỏ bên trong của một mảng thành phần tử cuối cùng của nó
- Trích xuất - Nhập các biến vào bảng ký hiệu hiện tại từ một mảng
- in_array - kiểm tra xem giá trị có tồn tại trong một mảng không
- Key_Exists - Bí danh của Array_Key_Exists
- Khóa - Lấy chìa khóa từ một mảng
- Krsort - Sắp xếp một mảng theo khóa theo thứ tự giảm dần
- KSORT - Sắp xếp một mảng theo khóa theo thứ tự tăng dần
- Danh sách - Gán các biến như thể chúng là một mảng
- Natcaseort - Sắp xếp một mảng bằng thuật toán "thứ tự tự nhiên" vô cảm trường hợp
- Natsort - Sắp xếp một mảng bằng thuật toán "thứ tự tự nhiên"
- Tiếp theo - tiến lên con trỏ bên trong của một mảng
- POS - Bí danh của hiện tại
- trước - tua lại con trỏ mảng bên trong
- Phạm vi - Tạo một mảng chứa một loạt các phần tử
- Đặt lại - Đặt con trỏ bên trong của một mảng thành phần tử đầu tiên của nó
- RSORT - Sắp xếp một mảng theo thứ tự giảm dần
- Shuffle - xáo trộn một mảng
- sizeof - bí danh của số lượng
- Sắp xếp - Sắp xếp một mảng theo thứ tự tăng dần
- UASORT-Sắp xếp một mảng với chức năng so sánh do người dùng xác định và duy trì liên kết chỉ mục
- UKSORT-Sắp xếp một mảng bằng các khóa bằng hàm so sánh do người dùng xác định
- usort-Sắp xếp một mảng theo các giá trị bằng hàm so sánh do người dùng xác định

Applegrew tại Rediffmail Dot Com ¶ ¶

14 năm trước

For newbies like me.

@var array<\My\Folder\ClassName>

0

@var array<\My\Folder\ClassName>

1

@var array<\My\Folder\ClassName>

2

@var array<\My\Folder\ClassName>

3

@var array<\My\Folder\ClassName>

4

@var array<\My\Folder\ClassName>

5

Tyler Bannister ¶

13 năm trước

@var array<\My\Folder\ClassName>

6

@var array<\My\Folder\ClassName>

7

@var array<\My\Folder\ClassName>

8

@var array<\My\Folder\ClassName>

5

Justin tại jmfrazier dot com ¶ ¶

2 năm trước

@var array

0

@var array

1

@var array

2

@var array<\My\Folder\ClassName>

5

macnimble tại gmail dot com ¶

13 năm trước

@var array

4

@var array

5

@var array

6

Justin tại jmfrazier dot com ¶

2 năm trước ¶

macnimble tại gmail dot com

@var array

8

@var array

9

@var array<\My\Folder\ClassName>

5

@var array

7 ¶

macnimble tại gmail dot com

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

1

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

2

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

3

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

4

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

5

@var array<\My\Folder\ClassName>

5

@var array

7 ¶

13 năm trước

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

7

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

8

/**
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

9

/**
 * blah
 * @return array array of types
 */

0

Justin tại jmfrazier dot com ¶

2 năm trước ¶

13 năm trước

/**
 * blah
 * @return array array of types
 */

2

/**
 * blah
 * @return array array of types
 */

3

/**
 * blah
 * @return array array of types
 */

4

@var array<\My\Folder\ClassName>

5

Justin tại jmfrazier dot com ¶ ¶

2 năm trước

/**
 * blah
 * @return array array of types
 */

6

/**
 * blah
 * @return array array of types
 */

7

/**
 * blah
 * @return array array of types
 */

8

/**
 * blah
 * @return array array of types
 */

9

@var array<\My\Folder\ClassName>

5

macnimble tại gmail dot com ¶

13 năm trước

array1

array2

array3

Justin tại jmfrazier dot com ¶ ¶

14 năm trước

array4

@var array

6

array6

@var array<\My\Folder\ClassName>

5 ¶

Tyler Bannister

array7

array8

@var array<\My\Folder\ClassName>

5

13 năm trước ¶

Justin tại jmfrazier dot com ¶

@return array0

@return array1

2 năm trước

macnimble tại gmail dot com ¶

14 năm trước

@return array3

@var array<\My\Folder\ClassName>

5 ¶

macnimble tại gmail dot com

@return array4

@return array5

@return array6

@var array<\My\Folder\ClassName>

5

programming php PHPDoc array keys Phpdoc array structure PHPDoc tuple Phpstan empty array PHPDoc associative array PHPDoc return array

Hướng dẫn phpdoc array of arrays - mảng phpdoc của mảng

CẬP NHẬT

Bài Viết Liên Quan

Quảng Cáo

Có thể bạn quan tâm

Toplist được quan tâm

Quảng cáo

Xem Nhiều

Quảng cáo

Chúng tôi

Điều khoản

Trợ giúp

Mạng xã hội