Tại sao nhận xét của C như/* */need '<'? hướng dẫn

Question

đội Mỹ C-code viết rằng nó muốn được tốt hơn để đặt một '<' trong một chú thích như hình dưới đây:

#define MAX_PACK_ITEM_NUM 50 /**< max number of item */ 

Tôi tự hỏi, việc sử dụng thực sự của này '<' là gì?

Answer 1

Đó là cách để doxygen tạo tài liệu cho các thành viên của tệp/struct/union/class/enum. Bằng cách sử dụng điểm đánh dấu đó, bạn có thể đặt nhận xét sau mỗi thành viên, dẫn đến ít lộn xộn hơn. Bạn có thể đọc thêm về nó here.

Answer 2

Tôi cho rằng nhóm của bạn sử dụng một số công cụ tài liệu tự động tìm kiếm /**<; ví dụ. Doxygen.

Answer 3

Đây là doxygen syntax để nhận xét thành viên sau khi khai báo/định nghĩa.

Answer 4

Khi những người khác đã trả lời, đây có thể là nhận xét dành cho doxygen. Khi phân tích các ý kiến, doxygen có một số quy tắc đặc biệt:

• Một bình luận bình thường bắt đầu với /* là lờ bởi doxygen.
• Nhận xét bắt đầu bằng /** được coi là tài liệu của mục tiếp theo sau khi nhận xét trong mã nguồn.
• Nhận xét bắt đầu bằng /**< được coi là tài liệu của mục ngay trước nhận xét trong mã nguồn.

Tài liệu chủ yếu được đặt phía trên mục được ghi tài liệu, ví dụ: một hàm. Nhưng trong một số trường hợp, chẳng hạn như #define, bạn nên đặt tài liệu ở cuối dòng và trong trường hợp đó, cần đánh dấu /**<.