2011-05-07 24 views
5

tôi nhận thấy rằng có rất nhiều kịch bản có những loại ý kiến:comments Weird trên tờ khai chức năng PHP

/** 
* Retrieve list of themes with theme data in theme directory. 
* 
* The theme is broken, if it doesn't have a parent theme and is missing either 
* style.css and, or index.php. If the theme has a parent theme then it is 
* broken, if it is missing style.css; index.php is optional. The broken theme 
* list is saved in the {@link $wp_broken_themes} global, which is displayed on 
* the theme list in the administration panels. 
* 
* @since 1.5.0 
* @global array $wp_broken_themes Stores the broken themes. 
* @global array $wp_themes Stores the working themes. 
* 
* @return array Theme list with theme data. 
*/ 
function get_themes() { 
    global $wp_themes, $wp_broken_themes; 

    ... 

    return $wp_themes; 
} 

Dường như một số loại tài liệu cho các chức năng, nhưng có chuyện gì thế với dòng chữ prepended với @?

Giống như @since, @global, @return, @access, @param etc ...?

Tôi biết ý của họ là gì, nhưng tại sao họ lại có @ trước mặt họ? Họ có cần phải xác định với một số loại ứng dụng tài liệu.

+0

Wow Tôi chưa bao giờ thực sự xem xét mã nguồn WP trước đây, 'toàn cầu $ wp_broken_themes' âm thanh giống như một số mã có khả năng khủng khiếp đang diễn ra! –

+0

Chúng không phải là "lạ". @ Wesley: WP code là khủng khiếp; tốt, đó là PHP để đi con số. –

+1

@Tomalak về PHP ghét: Nó không phải là chiếc xe, nó là người lái xe :) –

Trả lời

7

Đó là tiêu chuẩn JavaDoc. Nhiều khả năng tác giả đã chọn nó vì hầu hết các IDE tự động định dạng nó một cách độc đáo.

http://en.wikipedia.org/wiki/Javadoc

+0

xin cảm ơn! bạn có biết một IDE miễn phí thực hiện điều này không? Tôi đang sử dụng "chúng tôi xây dựng 2010" và họ xuất hiện như là ý kiến ​​ – Alex

+0

NetBeans là một IDE tuyệt vời miễn phí hỗ trợ Java (ofc.), C/+ +, Python, PHP và nhiều hơn nữa thông qua các mô-đun! – pkluz

+1

Tôi thứ hai NetBeans, chỉ cần thử nó tuần trước và đã rất ấn tượng. Tôi là một người nghiện Notepad ++ đang cố thoát khỏi thói quen và chuyển sang thứ gì đó mạnh mẽ hơn. –

3

Họ cần phải xác định với một số loại ứng dụng tài liệu.?

Chúng hữu ích với các nhà tài liệu tự động như phpDocumentor và nói chung là cách tốt để ghi lại mã của bạn. Là wasabi has pointed out, IDE cũng có thể chọn chúng và thực hiện một số công cụ hữu ích cho bạn, chẳng hạn như gợi ý loại đối số chức năng.

Thậm chí nếu bạn không ghi lại mã của mình, đó là thói quen tốt - bạn không cảm thấy cần phải mang theo nó ở một số người có xu hướng làm (ghi lại mọi thứ có thể).

3

Đó là PHPDoc, là một sự thích nghi của định dạng Javadoc yêu quý.

Các định dạng tài liệu này có thể dễ đọc hơn nhờ tính nhất quán được thực thi của chúng và hữu ích cho các IDE và trình tạo tài liệu tự động như phpdoc.

2

Điều này chắc chắn là PHP Documentator. Các phần "@something" được sử dụng để thêm thông tin vào tài liệu. Vui lòng xem PHP Documentator's documentation để biết chi tiết - thậm chí nó còn có công cụ để tạo tệp tài liệu từ các nhận xét (here) ở định dạng của Tài liệu PHP.

Hy vọng sẽ giúp bạn.