2012-02-21 29 views
5

Tôi đã gặp sự cố với PHP 5.3 không gian tên và nhận xét Doxygen.Làm thế nào để vô hiệu hóa cú pháp lệnh cắt giảm trong Doxygen

Ví dụ:

/** 
* Sample Method 
* 
* @param string $output 
* @return \Project\Lib\Rest 
*/ 

Doxygen mang lại cho tôi những lời cảnh báo sau đây:

warning: Found unknown command `\Project' 
warning: Found unknown command `\Lib' 
warning: Found unknown command `\Rest' 

Những gì tôi có thể làm gì để khắc phục điều này hoặc tắt \ lệnh và chỉ sử dụng @commands

Trả lời

5

Cố gắng thoát dấu gạch chéo ngược của bạn, tức là sử dụng

/** 
* Sample Method 
* 
* @param string $output 
* @return \\Project\\Lib\\Rest 
*/ 

\\ thực sự là lệnh doxygen chỉ in dấu gạch chéo ngược.

Xem thêm Documenting PHP with Doxygen: The Pros and Cons:

/** 
* Sample Method 
* 
* @param string $output 
* @return Project::Lib::Rest 
*/ 
+0

Đây không phải là tuyệt vời như vậy bởi vì sau đó kích đúp dấu gạch chéo sẽ được hiển thị cho người dùng đang chỉ đọc nguồn gốc của tài liệu (ví dụ như các tập tin tiêu đề), và nó có thể nhầm lẫn chúng. –

Các vấn đề liên quan