Tài liệu trợ giúp nhanh được tạo tự động Xcode 8


85

Trong số các tính năng mới được công bố trong Xcode 8 , chúng ta có thể thấy

"Tự động tạo tài liệu Trợ giúp Nhanh":

nhập mô tả hình ảnh ở đây

Đây có phải là phần cuối của tài liệu viết mã thủ công như chúng ta có thể tìm hiểu trên bài viết này từ NSHipster không?

Ai đó có thể phác thảo những ưu và nhược điểm của tính năng mới này không? Nó có thay thế các công cụ như Jazzy không?

Tôi không thể tìm thêm thông tin về tính năng mới.


@ Rob: Bất kỳ ý tưởng làm thế nào tôi có thể biển như thế nào có vẻ như không có sự đau đớn của việc cài đặt Xcode 8 Beta và gỡ bỏ cài đặt nó ngay sau khi (không được uỷ quyền để cài đặt nó trên mac công việc của tôi)
H4Hugo

Nó được chứng minh trong một số video WWDC 2016.
Rob


2
Bạn có thể xem bản demo trong video lúc 37:00 - tuy nhiên tôi không thể làm cho nó thực sự hoạt động! Tôi đã thử với swift và obj-c và với nhiều phần khác nhau của một hàm được chọn.
Vorlon bối rối

Câu trả lời:


203

Điều này đề cập đến tính năng Xcode 8 (và mới hơn), nơi bạn có thể chọn một phương pháp như sau:

func foo(bar: Int) -> String { ... }

... và sau đó nhấn + option+ /(hoặc chọn “Cấu trúc” »“ Thêm tài liệu ”từ menu“ Trình chỉnh sửa ”của Xcode) và nó sẽ tạo mẫu nhận xét sau cho bạn:

/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>

Nó chỉ tạo điều kiện cho việc viết tài liệu cho Trợ giúp Nhanh.


Lưu ý, mặc dù hành vi này đã thay đổi một chút theo thời gian, nhưng Xcode có thể nói rõ về vị trí phải đặt con trỏ khi bạn cố gắng thực hiện việc này. Ví dụ: con trỏ phải ở đâu đó trong tên hàm, footrong ví dụ trên của tôi, để điều này hoạt động. Hoặc chỉ cần nhấp đúp vào tên chức năng và sau đó nhấn + option+/


1
bạn có thể làm cho nó hoạt động không? Tôi không thể. Nếu bạn có thể; bạn đang chọn gì khi sử dụng lệnh? Tôi đã thử mọi lựa chọn ...
Vorlon bối rối.

2
Tôi chỉ cần đặt con trỏ của mình ở đâu đó trong tên phương thức và sau đó nhấn command + option + "/" (cũng như đã chọn "Editor" - "Structure" - "Thêm tài liệu") trong Xcode 8 và nó hoạt động tốt. Vấn đề duy nhất mà tôi gặp phải cho đến nay là nó dường như bị nhầm lẫn với @IBActioncác phương thức. Nhưng nó hoạt động tốt với cả Objective-C và Swift. Nếu bạn vẫn gặp sự cố và đã thử quy trình khập khiễng thông thường là khởi động lại Xcode và / hoặc khởi động lại máy, bạn có thể chỉ muốn đăng báo cáo lỗi về phần mềm beta này.
Rob

2
Tôi vừa thử khởi động lại, nhưng vẫn không có niềm vui. Tôi đã gửi một báo cáo lỗi.
Vorlon bối rối

5
Nó thực sự đang hoạt động kể từ Xcode 8 beta 1, nhưng nếu bạn đang sử dụng El Capitan, bạn cần khởi chạy Xcode, để nó cài đặt các thành phần hệ thống cần thiết, sau đó chạy sudo /usr/libexec/xpccachectltrong Terminal và khởi động lại máy Mac của bạn trước khi nó hoặc bất kỳ Phần mở rộng Xcode nào khác sẽ công việc. Xem ghi chú phát hành Xcode 8.
Chris Hanson

1
Tôi thấy rằng nó hoạt động không thường xuyên. Đôi khi nó hoạt động tuyệt vời và những lúc khác thì không. Tôi cũng chưa khám phá ra tại sao. Thành thật mà nói, khi nó hoạt động, tôi thấy những thứ mà nó tự động tạo ra khá thưa thớt (tên phương thức trong Mô tả?). Đối với những người trong số các bạn, nó hoạt động không có vấn đề gì, thật tuyệt vời. Đối với một số người trong chúng ta, nó là rời rạc hoặc không hoạt động.
Lloyd Sargent

7

Điều này rất có thể liên quan đến thực tế là TẤT CẢ các phím nóng có dấu '/' không hoạt động trong bản dựng XCode 8 hiện tại, nếu bàn phím của bạn yêu cầu nhấn shift để lấy nó.

Tức là trên bàn phím tiếng Đức, '/' là shift + 7, nhấn alt + cmd + shift-7 không làm được gì. Nếu bạn gán tức là cmd + shift + opt + d, nó hoạt động tốt.

Phím tắt '///', không may là hiện cũng không hoạt động, có thể là do plugin XCode cũ VVDocumenter, đã sử dụng chính xác phím tắt này.

Tính năng tuyệt vời, QA tệ hại ở phía Apple.


Đã có lỗi này trong Xcode 8 beta nhưng nó đã được sửa trong phiên bản đã phát hành.
Eric Aya

8A218a là phiên bản đã phát hành - và phím tắt nhận xét hoạt động trở lại đối với tôi (không có trong betas).
Eric Aya

Bạn có đang sử dụng bố cục bàn phím, nơi bạn nhận được '/' mà không cần sử dụng phím shift không?
Klaus Busse

Có, tôi có hai bàn phím, một bàn phím Azerty của Pháp có "/" ở đầu ":" và một bàn là Qwerty của Mỹ. Cả hai đều hoạt động tốt đối với phím tắt nhận xét.
Eric Aya

Vâng, nó là không liên tục đối với tôi (bàn phím tiếng Mỹ).
Lloyd Sargent
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.