tài liệu tham số chức năng doxygen (//! <Vs @param)

Question

Nếu tôi sử dụng tài liệu "sau thành viên" cho tham số chức năng, ví dụ, sử dụng //!< sau mỗi thông số, thay vì @param trong tiêu đề, "Tham số" phần luôn được đặt sau "Quay lại" trong tệp đầu ra được tạo.

Có thể xác định thứ tự sao cho "Thông số" sẽ được đặt trước "Trả lại" không?

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI(
    int argument1,  //!< first argument 
    int argument2  //!< second argument 
    ); 

Answer 1

Tôi vừa thử mã của bạn với Doxygen 1.7.5.1 và xác nhận rằng với mã của bạn, danh sách Tham số trong đầu ra xuất hiện sau mô tả Trả về.

Đây là một sự xấu hổ, như //!< phong cách đẹp hơn nhiều so với việc để lại trạng thái tên của tất cả các thông số với @param:

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @param  argument1 first argument 
* @param  argument2 second argument 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI2(
    int argument1, 
    int argument2 
    ); 

tôi đã có một cái nhìn trong Doxygen Bugzilla bug database, để xem nếu nó là một lỗi tương đối gần đây (khi đó bạn có thể thử hoàn nguyên về cài đặt cũ hơn).

Tôi tin rằng bạn đã tìm thấy Doxygen Bug 316311: 'tài liệu tham số sau khi trả lại tài liệu bằng cách sử dụng nhận xét nội tuyến', được báo cáo vào tháng 9 năm 2005 và chưa được khắc phục.

Rất tiếc, tôi sợ câu trả lời cho câu hỏi của bạn Có thể xác định thứ tự sao cho "Thông số" sẽ được đặt trước "Trả lại" không? là gần như chắc chắn số

Sửa

Tôi vừa mới bổ sung thêm một lưu ý để Doxygen Bug 316311, yêu cầu nó phải được thay đổi để Status = khẳng định.