2012-09-14 24 views
6

Khi tôi đang gõ lên một đối tượng Cocoa và gọi một bộ chọn trên đối tượng đó, đôi khi tôi có thể thấy thông tin 'tài liệu' hoặc 'trợ giúp' về phương pháp đó. Ví dụ: khi tôi nhập [NSArray alloc], tôi thấy hai gợi ý trợ giúp. Một cho số NSArray và một cho số alloc. Cả hai xuất hiện trong hộp danh sách đề xuất tự động điền bật lên khi tôi nhập mã.Làm thế nào để trang trí các phương pháp Objective C với tài liệu?

Làm cách nào để tạo các gợi ý trợ giúp được trang trí theo lớp/phương pháp tương tự sẽ xuất hiện khi tôi nhập? Tôi muốn xem nhận xét của mình khi tôi nhập tên lớp tùy chỉnh và phương thức tùy chỉnh của mình. Tôi có thể làm cái này như thế nào?

Ví dụ: C# cung cấp tính năng này thông qua tài liệu XML có thể được đặt trước bất kỳ khai báo phương thức, lớp hoặc giao thức/giao thức nào.

+1

_ "Tôi muốn xem nhận xét của mình khi tôi nhập tên lớp tùy chỉnh và phương thức tùy chỉnh của mình." _ Điều này rất hữu ích. :) – Kjuly

Trả lời

7

Bạn phải tạo "docset". Có các công cụ như appledoc để tạo tài liệu từ nhận xét của bạn. Bạn có thể thiết lập một giai đoạn xây dựng chạy appledoc trên mã của bạn.

Vấn đề là không có cách nào để làm cho Xcode 4 tải lại một docset trừ khi khởi động lại Xcode. Vì vậy, ngay cả khi bạn chạy appledoc tự động như là một phần của xây dựng của bạn, bạn sẽ phải khởi động lại Xcode để làm cho nó thấy những thay đổi đối với tài liệu của bạn.

+0

+1 Khung công tác appledoc thực hiện công việc tuyệt vời khi tạo các tài liệu là công dân hạng nhất trong Xcode. – jlehr

+0

Có; nó thực sự là loại đáng ngạc nhiên với tôi lần đầu tiên tôi nhìn thấy tài liệu của tôi side-by-side với Apple. Tôi đã không chắc chắn tôi đã sẵn sàng cho điều đó .... May mắn thay, appledoc cũng sẽ tạo ra HTML. –

+0

Huh, đó là một số lượng đáng thất vọng của công việc, nhưng tôi cho rằng nó là tốt hơn so với không có gì! – Brett

Các vấn đề liên quan