2012-07-26 17 views
11

ok tôi có PHPDoc này trên các phương pháp lớp học của tôihai hay nhiều kiểu dữ liệu trong PHPDoc @ param

/** 
* this a function that translates the text 
* @param string|boolean $lang if string the string given in the parameter will be the language code that will represent the language desired, if true, this will translate based on the website's current language, if false will not translate. 
*/ 

bây giờ vấn đề của tôi là, là làm thế nào tôi có thể xác định kiểu dữ liệu của $lang có thể chấp nhận cả hai chuỗi và boolean ONLY.

Trong các tài liệu khác tôi thấy mixed nhưng không phản ánh chính xác trong IDE Eclipse của tôi với PDT.

Câu hỏi của tôi là cách tiêu chuẩn về cách tôi có thể hiển thị một số nhất định @param có thể chấp nhận hai hoặc nhiều loại kiểu dữ liệu.

LƯU Ý: phpdoc tôi đã cung cấp là tài liệu hiện có của ứng dụng tôi hiện đang làm việc. Tôi cũng được chỉ định để ghi lại mọi thứ tốt.

Trả lời

19

Bạn đã làm đúng. PHPDoc reference cung cấp hai tùy chọn này cho các tham số có thể là nhiều loại dữ liệu (nhấn mạnh mỏ).

Các kiểu dữ liệu nên là một loại hợp lệ PHP (int, string, bool, vv), một tên lớp cho các loại đối tượng, hoặc đơn giản là "hỗn hợp". Hơn nữa, bạn có thể liệt kê nhiều kiểu dữ liệu cho một tham số bằng cách phân tách chúng bằng các đường ống (ví dụ: "@param int | string $ p1").

+0

ahh .. well im chỉ lo lắng tại sao PDT nhật thực không hiển thị tốt. ok cảm ơn bạn –

+0

@Mahan Có hiển thị nó khác với '@param integer' hoặc' @param boolean' không? –

+0

Tôi nghĩ PDT vẫn có một số tiến triển liên quan đến việc có thể giải thích mọi thứ mà các tài liệu PHP đã phát triển để chứa đựng. Có lẽ một nghiên cứu để xây dựng một bản tóm tắt về số lượng thông tin docblock mỗi phiên bản PDT biết cách sử dụng theo thứ tự. – ashnazg