Phân tích tài liệu mới của Xcode 5 hoạt động như thế nào?

Question

Tôi đã nhận thấy rằng Xcode 5 giờ đây tự động phân tích cú pháp tài liệu phương pháp. Ví dụ:

/** 
Fetches a conversation with user. 

@param user The other user in the conversation. 

@return A conversation 
*/ 
+ (Conversation *)conversationWithUser:(User *)user; 

Hỗ trợ nhiều mã @ (không biết cách gọi cho chúng). Ví dụ:

• @warning
• @note

Tuy nhiên, tôi vẫn chưa tìm được cách này hay cách gì định dạng này là, để tôi có thể thêm đậm văn bản, hoặc nghiêng hoặc liên kết.

Có ai biết định dạng tài liệu này là gì không?

Answer 1

Theo các tính năng mới trong XCode 5 (Theo Documentation):

tài liệu dự án từ tài liệu khuôn khổ tham khảo API và ý kiến ​​có cấu trúc trong mã nguồn của bạn được hiển thị trong bảng điều khiển giúp đỡ nhanh chóng và trong mã hoàn thành chế độ xem cửa sổ bật lên. Các nhận xét có cấu trúc Doxygen và HeaderDoc là các định dạng được hỗ trợ.

Bạn có thể kiểm tra Header Doc User guide.

Rõ ràng, nó sử dụng một tập hợp con các tính năng này, nhiều tính năng không hoạt động.

Answer 2

Nó không hoàn chỉnh. Nó không hỗ trợ tất cả các thẻ doxygen vào lúc này - chỉ là một tập con cơ bản. Trong thời gian chờ đợi, bạn có thể sử dụng các cờ như -Wdocumentation và -Wdocumentation-unknown-command (hoặc tốt hơn, bắt đầu với -Weverything và giảm), và clang sẽ thông báo cho bạn nếu nó gặp phải thứ gì đó không được nhận dạng hoặc không đúng định dạng. Nếu bạn muốn có một danh sách đầy đủ các thẻ nào có sẵn, tôi sẽ kiểm tra thân cây.

Answer 3

Tôi đã tìm hiểu cách in đậm và in nghiêng. Nó sử dụng this Doxygen format. Dường như không nhận ra tất cả các lệnh nhưng một số công việc:

/** 
Resumes \b network operation queues. 
*/ 
- (void)resume; 

\b sẽ làm cho mạng trở nên đậm. \a in nghiêng và \c văn bản đơn cách.