Làm cách nào để ghi lại một mảng của [loại]?

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 phải ghi lại kiểu trả về của hàm. Tôi có thể tất nhiên chỉ cần sử dụng array, nhưng điều đó không cung cấp tất cả các thông tin có thể được cung cấp, và không nói cho 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 [loại]" trong PHPDoc?

Answer 1

Từ các tài liệu của phpDocumentor

Giá trị đại diện theo loại có thể là một mảng. Các loại phải được xác định sau khi định dạng của một trong các tùy chọn sau:

1. không xác định, không có định nghĩa về các nội dung của mảng đại diện được đưa ra. Ví dụ: @return array

2. được chỉ định có chứa một loại duy nhất, định nghĩa Loại thông báo cho người đọc loại của từng phần tử mảng. Chỉ một loại được mong đợi là phần tử cho một mảng nhất định.

   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àng tốt.

3. được chỉ định chứa nhiều loại, định nghĩa Loại thông báo cho người đọc loại của mỗi phần tử mảng. Mỗi phần tử có thể thuộc bất kỳ loại nào. Ví dụ: @return (int|string)[]

   Note
   nhiều IDE có lẽ không hỗ trợ ký hiệu này được nêu ra.

Answer 2

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

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

Answer 3

Trong PHPDoc bạn có thể làm như sau cho loại thành viên mảng gián tiếp:

@var array<\My\Folder\ClassName>