Tại sao phải khai báo loại biến PHP trong một nhận xét?

Question

Tôi khá mới đối với PHP và tôi mới bắt đầu sử dụng NetBeans để phát triển mã PHP của mình.

Trong số màu xanh dương, khi tôi nhập một biến trong truy vấn, một hộp thoại xuất hiện và yêu cầu tôi hoàn thành nhận xét để giữ loại biến. Tôi đã làm một số điều tra và thấy rằng đây có vẻ là một tính năng phổ biến của NetBeans, nhưng tôi không thể tìm thấy bất kỳ thông tin nào để giải thích cho tôi lý do tại sao đây là trường hợp.

Tại sao một người nào đó muốn đặt loại biến PHP trong nhận xét? Là nó để sử dụng phát triển, hay nó thực sự có lợi cho chính mã? Là nó không thể thiếu, hoặc tùy chọn?

Answer 1

Thêm loại trong thẻ @var vào trong nhận xét của phương thức sẽ cho phép NetBeans hiển thị cho bạn mã hoàn thành. Điều này tất nhiên là tùy chọn nhưng nó luôn luôn là một ý tưởng tốt để tài liệu đầy đủ mã của bạn.

Chỉnh sửa: Mẹo để NetBeans tự động tạo nhận xét cho bạn là sử dụng mở rộng /**. Để thực hiện việc này, chỉ cần đặt con trỏ lên trên thuộc tính hoặc phương thức bạn muốn tạo tài liệu và nhập /** rồi nhấn phím ENTER. Điều này sẽ mở rộng nhận xét kiểu phpDoc và thêm các thẻ thích hợp.

Chỉnh sửa 2: Bạn có thể sử dụng thẻ @var trên một bất động sản và bạn có thể sử dụng thẻ @param trên một phương pháp để đạt được tác dụng tương tự với các tham số được truyền vào một phương pháp.

Sử dụng thẻ @var trên một bất động sản sẽ cung cấp cho bạn những gợi ý mã trong khi sử dụng bất động sản bất kỳ nơi nó có thể nhìn thấy:

/** 
* 
* @var My_Type 
*/ 
private $_myProperty; 

Sử dụng thẻ @param trên một phương pháp sẽ cung cấp cho bạn những gợi ý mã trong khi sử dụng tham số bên trong phương pháp:

/** 
* 
* @param My_Type $obj 
*/ 
public function myMethod($obj) { 

} 

một cách khác để đạt được một hiệu ứng tương tự khi cũng cung cấp một lượng ít các loại an toàn là sử dụng cơ chế type hinting PHP:

public function myMethod(My_Type $obj) { 

} 

Lưu ý rằng phương thức này có loại được chỉ định trong chữ ký phương thức. NetBeans bây giờ sẽ cung cấp cùng một mã hoàn thành bên trong phương thức có sẵn bằng cách sử dụng thẻ @param và PHP sẽ tạo ra một E_RECOVERABLE_ERROR nếu loại được chuyển vào phương thức không phải là cùng một loại được chỉ định. Xem PHP's documentation regarding errors và cách xử lý chúng nếu bạn quan tâm đến việc tìm hiểu thêm về lỗi trên.

Answer 2

Vì PHP là ngôn ngữ được đánh máy/vịt, khi bạn tạo một chương trình lớn, các gợi ý kiểu đó có thể giúp bạn hoặc người khác hiểu được những gì đang diễn ra nếu vấn đề phát sinh. Ví dụ, mong đợi một loại hỗn hợp và gửi một số nguyên.

Answer 3

Tôi đoán bạn đang nói về một cái gì đó như thế:

/** 
* @var SimpleXMLElement $xml 
*/ 
private $xml; 

này được gọi như vậy phpDoc comment. Nó cho phép bạn tạo tài liệu API (like this one for instance). Hơn nữa, hầu hết các IDE bao gồm Eclipse và NetBeans cũng hỗ trợ cú pháp đó, và cung cấp hoàn thành mã động vv

Answer 4

Mặc dù netbeans sử dụng nó cho autocompletion nó thường là hữu ích cung cấp tư liệu mã của bạn:

Trong trường hợp này bạn biết những gì phương pháp này được và những gì nó trả nhưng bên trong mã bạn không có ý tưởng những gì đang xảy ra

/** 
* Returns some stuff 
* @param string $someObj 
* @return array 
*/ 
public function someMethod($someObj) { 
    $factoredObj = getObject($someObj); //you are not sure what type it returns 
    $resultArray = $factoredObj->toArray(); 
    return $resultArray; 
} 

Bạn có thể bình luận nó với /* @var $variable type */ bên trong mã

/** 
* Returns some stuff 
* @param string $someObj 
* @return array 
*/ 
public function someMethod($someObj) { 
    /* @var $factoredObj someType */ 
    $factoredObj = getObject($someObj); 
    $resultArray = $factoredObj->toArray(); 
    return $resultArray; 
} 

hoặc

$factoredObj = getObject($someObj); /* @var $factoredObj someType */ 

Answer 5

Nếu bạn muốn khai báo kiểu biến trong trường hợp biến không phải là thuộc tính lớp mà chỉ là biến chứa một số giá trị trả về, hãy sử dụng nhận xét một sao theo sau @var. và cuối cùng là loại biến đó. Ví dụ:

/* @var $errorMessage NotificationMessage */ 
$errorMessage= $allMessages->rewind()->current(); 

sẽ thông báo cho NetBeans hoặc PhpStorm rằng $ errorMessage là phiên bản của NotificationMessage và bạn sẽ hoàn thành mã cho biến đó.