Cách tạo tài liệu cho biến mẫu và phương thức trong Xcode?

Question

Tôi muốn có thể Alt-Click một biến mẫu (hoặc một phương pháp) như là một phần của chương trình tôi đã tạo và đọc mục đích của nó là gì.

Thực tế Xcode đang cho tôi biết biến lớp được khai báo tại - là tốt nhưng không đủ. Trong trường hợp này, tôi muốn xem văn bản tùy chỉnh mà tôi đã nhập để mô tả một thực tế là asset. Ngoài ra loại ivar cũng sẽ hữu ích để biết.

Làm cách nào để thực hiện điều này? Trong trường hợp này, tôi tự hỏi chính xác những gì đã làm tôi có nghĩa là bởi assets

Tôi đặc biệt tự hỏi, nếu những thông tin này có thể được nhìn từ bên trong Xcode, tương tự như cách Eclipse lãm JavaDoc nội dung.

Answer 1

Bạn sẽ cần phải tạo một tập tài liệu cho dự án của bạn và cài đặt nó trong Xcode. appledoc có thể giúp bạn với điều này. Đây là một công cụ dòng lệnh có thể tạo tài liệu theo phong cách của Apple từ các nhận xét được định dạng đặc biệt trong tiêu đề của bạn. Bạn cũng có thể tích hợp điều này vào quá trình xây dựng của bạn với giai đoạn xây dựng tập lệnh chạy, để tài liệu luôn được cập nhật.

Đối với các dự án nhỏ, thường không đáng để thử và bạn có thể chỉ cần thêm nhận xét vào tệp tiêu đề và nhảy ở đó bằng Cmd-click (Ctrl + Cmd + mũi tên trái để quay lại vị trí của bạn đến từ).

Answer 2

Có thể bạn sẽ muốn xem tài liệu của Apple trên Documentation Sets cũng như bài viết của họ trên generating doc sets using Doxygen. Cái thứ hai dựa trên Xcode 3.x, vì thế mức độ liên quan của nó có phần nghi ngờ, nhưng dù sao thì cũng tốt hơn.

Điều đó nói rằng, nếu bạn quyết định sử dụng Doxygen (các lựa chọn thay thế như HeaderDoc có thể được sử dụng cho tài liệu, nhưng tôi không chắc chắn những gì có sẵn cho bạn khi tạo bộ tài liệu), có vẻ như điểm chính là bạn sẽ muốn ném GENERATE_DOCSET=YES vào Doxyfile của bạn (hoặc bất kỳ điều gì bạn quyết định gọi nó). Sau đó, bạn chỉ cần ném kết quả vào ~/Library/Developer/Shared/Documentation/DocSets (theo tài liệu của Doxygen). Tôi không biết liệu điều này có hiệu quả trong Xcode 4.x hay không - nó đáng để bắn, và thật tuyệt khi được nghe lại.

Lưu ý: hầu hết điều này được dựa trên this answer bởi Barry Wark. Hình tín dụng là do có, vì tôi sẽ không có bothered nhìn vào điều này là nó không cho câu trả lời của mình.