Tài liệu về nhận xét tài liệu Qt? Qt + Doxygen?

Question

Tôi có thể tìm tài liệu về nhận xét tài liệu về Qt ở đâu? Tôi đang đề cập đến cách Qt sử dụng một phong cách cụ thể cho các nhận xét về tài liệu, như vậy:

/*! 
    \class MyClassName 
    \brief The MyClassName class is used as an example on Stack Overflow. 

    This class serves a few functions, the most important being: 

    \list 
     \i So people can understand my question. 
     \i So people can have a few laughs at the comedy in my example. 
    \endlist 
*/ 

... bạn nhận được ảnh. Vì vậy, nơi tôi có thể tìm thấy thông tin về tất cả các thiết bị chuyển mạch, như \ class, \ list, \ brief, v.v. Ngoài ra, tôi sử dụng công cụ nào để tạo tệp tài liệu từ các nhận xét này trong tệp nguồn của tôi? Doxygen có hỗ trợ cú pháp này không?

Answer 1

Không sử dụng qdoc. It is deprecated. Sử dụng Doxygen, dựa trên qdoc.

Điều đó nói rằng, tài liệu (ở định dạng qdoc :-D) là here.

Answer 2

Bạn có thể có một cái nhìn vào mã nguồn Qt tự cho ý kiến ​​tài liệu Qt ...

Qt - SRC - 4.6.3

Tôi đã sử dụng Doxygen cho tài liệu và đối với tôi nó làm việc tốt, mặc dù các tài liệu tiêu chuẩn không phải là Qt. Tôi đề nghị bạn hãy thử và quyết định.

Answer 3

Sử dụng Doxygen để tạo ra tài liệu

Nó có thể tạo ra một trình duyệt trên mạng tài liệu (trong HTML) và/hoặc một hướng dẫn tham khảo off-line (LaTeX) từ một tập hợp các file nguồn tài liệu. Ngoài ra còn có hỗ trợ cho việc tạo ra đầu ra trong RTF (MS-Word), PostScript, PDF siêu liên kết, HTML nén và các trang người dùng Unix. Tài liệu được trích xuất trực tiếp từ các nguồn, giúp dễ dàng hơn trong việc giữ tài liệu phù hợp với mã nguồn.

Bạn có thể định cấu hình doxygen để trích xuất cấu trúc mã từ các tệp nguồn không có giấy tờ. Điều này rất hữu ích để nhanh chóng tìm thấy cách của bạn trong các bản phân phối nguồn lớn. Bạn cũng có thể hình dung mối quan hệ giữa các phần tử khác nhau bằng cách bao gồm đồ thị phụ thuộc, sơ đồ thừa kế và sơ đồ cộng tác, tất cả đều được tạo tự động.

http://www.stack.nl/~dimitri/doxygen/

Answer 4

Có hai bộ phận của Doxygen mà qt cụ thể: các Qt Comment Phong cách và thẻ cấu hình doxyfile QT_AUTOBRIEF. Đây chỉ là những phần của doxygen được QT sử dụng. Tất cả các bình luận doxygen sử dụng bởi QT là công cụ doxygen thường xuyên. Vì vậy, bạn chỉ cần đọc trên doxygen.

Hoặc có lẽ là bạn thực sự tìm kiếm tài liệu của ruột QT, chẳng hạn như thông tin về d-Pointers như chứa trong this blog entry

Qt Phong cách Bình luận: Các \ *! văn bản */ kiểu nhận xét được gọi là "Phong cách Qt" của các bình luận doxgyen. Các "!" đánh dấu toàn bộ khối nhận xét dưới dạng khối nhận xét doxygen. Đó là một phần tiêu chuẩn, tùy chọn của Doxygen.

thiết lập QT_AUTOBRIEF: nếu "QT_AUTOBRIEF" tag được đặt là TRUE trong Doxyfile, dòng đầu tiên của một Qt khối phong cách bình luận được tự động hiểu là mô tả \ ngắn.

Từ sự giúp đỡ doygen GUI:

thẻ QT_AUTOBRIEF được thiết lập để YES sau đó Doxygen sẽ diễn giải dòng đầu tiên (cho đến khi chấm đầu tiên) của một Qt kiểu bình luận như mô tả ngắn gọn. Nếu thiết lập để NO, comments sẽ cư xử giống như thường xuyên comments Qt-style (do đó đòi hỏi một rõ ràng lệnh \ ngắn gọn cho một mô tả ngắn gọn.)