Làm thế nào để thêm không gian màu trắng trong các bình luận trong Doxygen

Question

Tôi đã tự hỏi là có cách nào để chèn không gian màu trắng trong các bình luận trong html của Doxygen? Tôi đã tìm kiếm hướng dẫn trực tuyến và Doxygen, nhưng tôi không thể tìm thấy bất cứ điều gì để làm điều đó.

Ví dụ, tôi đang cố gắng để thêm bình luận như sau:

//! motor_id,   motor direction, accel,  min veloc,  max veloc\n 
//! GAUGE_MOTOR_1,  CLOCKWISE,   100,  1,    360\n 
//! GAUGE_MOTOR_2,  CLOCKWISE,   100,  1,    360\n 
//! GAUGE_MOTOR_3,  CLOCKWISE,   100,  1,    360\n 
//! GAUGE_MOTOR_4,  CLOCKWISE,   100,  1,    360\n 
//! GAUGE_MOTOR_5,  CLOCKWISE,   400,  200,   350\n 

Nhưng sản lượng html cho thấy kết quả như thế này

motor_id, motor direction, accel, min veloc, max veloc 
GAUGE_MOTOR_1, CLOCKWISE, 100, 1, 360 
GAUGE_MOTOR_2, CLOCKWISE, 100, 1, 360 
GAUGE_MOTOR_3, CLOCKWISE, 100, 1, 360 
GAUGE_MOTOR_4, CLOCKWISE, 100, 1, 360 
GAUGE_MOTOR_5, CLOCKWISE, 400, 200, 350 

Các khoảng trắng giữa hai từ sẽ được co một không gian do dogengen tự động. Có ai biết cách sửa lỗi này không? Điều đó sẽ giúp ích rất nhiều.

Cảm ơn bạn rất nhiều.

Answer 1

Bạn có thể sử dụng một trong hai

//! <pre> 
//! motor_id,   motor direction, accel,  min veloc,  max veloc 
//! GAUGE_MOTOR_1,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_2,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_3,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_4,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_5,  CLOCKWISE,   400,  200,   350 
//! </pre> 

hoặc

//! \verbatim 
//! motor_id,   motor direction, accel,  min veloc,  max veloc 
//! GAUGE_MOTOR_1,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_2,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_3,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_4,  CLOCKWISE,   100,  1,    360 
//! GAUGE_MOTOR_5,  CLOCKWISE,   400,  200,   350 
//! \endverbatim 

Sau đó sẽ thực sự hiển thị các văn bản như nó vốn có. Trước đây sẽ vẫn cho phép doxygen diễn giải lệnh bên trong khối, trong khi vẫn giữ khoảng trắng.

Answer 2

Trong trường hợp như thế này, tôi thấy hữu ích khi sử dụng bảng HTML và đặt nội dung trong một tệp riêng biệt. Ví dụ, bạn có thể tạo một tệp có tên "motors.html", đặt nó vào vị trí nơi doxygen của bạn được định cấu hình để tìm tệp đầu vào và sau đó sử dụng lệnh sau để bao gồm motors.html vào mã nguồn của bạn:

@htmlinclude motors.html 

Trong motors.html, bạn có thể có một cái gì đó dọc theo dòng sau đây:

<center> 
<table border="0"> 
<tr> 
    <th>motor_id</th> 
    <th>motor direction</th> 
    <th>accel</th> 
    <th>min veloc</th> 
    <th>max veloc</th> 
<tr> 
<tr> 
    <td>GAUGE_MOTOR_1</td> 
    <td>CLOCKWISE</td> 
    <td>100</td> 
    <td>1</td> 
    <td>360</td> 
</tr> 
... 
</table> 
</center> 

bạn có thể sử dụng một file CSS để định dạng bàn.