Sau khi thực hiện một số nghiên cứu về cách tốt nhất để lập tài liệu mã nhanh. Tôi bắt gặp Jazzy và cách thực hiện đơn giản như thế nào. Vì vậy, tôi làm theo phần cài đặt của Jazzy Documentation. Tôi chạyJazzy không hoạt động như mong đợi để tạo tài liệu nhanh chóng
sudo gem install jazzy
Sau đó, tôi tìm đến thư mục gốc của dự án của tôi, trong nhà ga, và chạy jazzy mà tạo ra một thư mục có tên "tài liệu" với một trang web có hiển thị tài liệu cho 1 lớp. Tôi có 87 lớp học mà tôi có thể nhìn thấy rõ ràng jazzy looping thông qua trong đầu ra thiết bị đầu cuối.
Tôi đã đọc NSHipster Tutorial về mã tài liệu cũng liên kết bạn đến Jazzy Documentation cũng như Markup Formatting Reference. Tôi đã làm tài liệu một số mã, mà Xcode hiển thị chính xác trong khung bên hoặc nhấp chuột phải vào chức năng hoặc lớp học. Vì vậy, tôi khá chắc chắn rằng cú pháp của tôi là chính xác.
Tôi đã dành một chút thời gian để so sánh 1 tệp đó với một tệp khác không được hiển thị và tôi không thấy bất kỳ điều gì khác thường xảy ra liên quan đến định dạng.
Tôi đang chạy:
- phiên bản jazz: 0.3.2
- phiên bản Xcode: 7.1
- Swift phiên bản: 2.1
- OS X El Capitan Version: 10,11
Câu hỏi tổng thể của tôi là; Tại sao không phải là tài liệu sản xuất vui vẻ cho tất cả các lớp học và làm thế nào tôi có thể khắc phục vấn đề này?
oo cảm ơn, tôi đã cảm thấy khó chịu như thế nào nói như 68% tài liệu –
Và có cách nào để ghi lại tất cả ACL (công khai, riêng tư, nội bộ?) Nếu tôi sử dụng '--min-acl internal' Tôi không thấy các phương pháp công khai được ghi lại. –
Thêm tài liệu vào đầu lớp học và nó sẽ hoạt động –