Cách thực hiện tài liệu trong mục tiêu C?

Question

Có ai có thể chia sẻ các cách để làm tài liệu trong mục tiêu C không? Có cách nào tiêu chuẩn như trong java?

Answer 1

Tôi không biết bạn đang sử dụng IDE nào nhưng Doxygen cho phép bạn tạo tài liệu từ nhận xét trong Mục tiêu-C (cũng như C, C++, Java và một số thứ khác).

Nếu bạn đang sử dụng Xcode (chỉ là giả định, kể từ khi bạn đang sử dụng Objective-C), có dường như có một số mức độ hội nhập (không thử nghiệm của tôi, chỉ cần tìm thấy trên Google): http://developer.apple.com/tools/creatingdocsetswithdoxygen.html

Answer 2

Tôi nghĩ bạn đang tìm kiếm Doxygen.

Answer 3

Tin tốt cho tất cả! : D Cuối cùng sau khi chờ đợi một thời gian dài Apple đã giới thiệu một ý kiến ​​phân tích cú pháp cho các dự án của chúng tôi. Theo new features trong XCode 5:

tài liệu dự án từ tài liệu tham khảo khung API và bình luậ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 quan điểm hoàn thành mã popover. Doxygen và HeaderDoc nhận xét có cấu trúc được hỗ trợ định dạng.

và từ các ghi chú Clang 3.2 phát hành:

Clang phân tích các ý kiến ​​và có thể phát hiện lỗi cú pháp và ngữ nghĩa trong ý kiến. Các cảnh báo này được tắt theo mặc định. Vượt qua -Wdocumentation cờ để bật cảnh báo về nhận xét tài liệu.

Nếu bạn muốn xem một ví dụ về tính năng mới này, tôi khuyên bạn hãy xem bài viết sau: Documentation in Xcode 5

Answer 4

Các chuẩn cách, như @DiegoPalomar đề nghị, là sử dụng HeaderDoc , Công cụ riêng của Apple để nhúng nhận xét có cấu trúc vào mã nguồn.

Nó đi kèm với Xcode, vì vậy không cần cài đặt. Nó đi kèm với một kịch bản dòng lệnh tạo ra đầu ra HTML của tài liệu của bạn.

Documents cho HeaderDoc:

• Introduction
• HeaderDoc command-line tool
• HeaderDoc markup

Dưới đây là một ví dụ:

/*! 
* Takes in a number and adds 4 to it. 
* 
* @param myNumber a number of type NSInteger. 
* 
* @return The number with 4 added to it. 
*/ 
- (NSInteger)addFour:(NSInteger)myNumber { 
    return myNumber + 4; 
} 

Bi g cộng: khi bạn Alt-click vào phương pháp ghi chép của bạn, doc của bạn xuất hiện trong bóng:

HeaderDoc là mã nguồn mở quá: http://www.opensource.apple.com/source/headerdoc/