Dokumentacja szybkiej pomocy generowana automatycznie przez Xcode 8


85

Wśród nowych funkcji ogłoszonych w Xcode 8 możemy zobaczyć

„Automatycznie generuj dokumentację szybkiej pomocy”:

wprowadź opis obrazu tutaj

Czy to koniec dokumentacji kodu ręcznego, jakiej możemy się nauczyć z tego artykułu z NSHipster ?

Czy ktoś może przedstawić zalety i wady tej nowej funkcji? Czy zastępuje narzędzia takie jak Jazzy ?

Nie udało mi się znaleźć więcej informacji o nowej funkcji.


@Rob: Każdy pomysł, jak mógłbym zobaczyć, jak to wygląda, bez bólu instalacji Xcode 8 bêta i odinstalowania go zaraz po (nie mam uprawnień do zainstalowania go na moim komputerze Mac)
H4Hugo

Jest to pokazane w niektórych filmach WWDC 2016.
Rob


2
Możesz zobaczyć demo na wideo o 37:00 - jednak nie mogę sprawić, by faktycznie działało! Próbowałem ze swift i obj-c oraz z różnymi wybranymi częściami funkcji.
Confused Vorlon

Odpowiedzi:


203

Odnosi się to do funkcji Xcode 8 (i nowszych), w której można wybrać taką metodę:

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

... a następnie naciśnij + option+ /(lub wybierz „Struktura” »„ Dodaj dokumentację ”z menu„ Edytor ”Xcode) i wygeneruje dla Ciebie następujący szablon komentarzy:

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

Po prostu ułatwia pisanie dokumentacji dla Szybkiej pomocy.


Zauważ, że chociaż to zachowanie zmieniło się nieco w czasie, Xcode może zwracać szczególną uwagę na to, gdzie musi znajdować się kursor, gdy próbujesz to zrobić. Na przykład kursor musi znajdować się gdzieś w nazwie funkcji, foow moim powyższym przykładzie, aby to zadziałało. Lub po prostu kliknij dwukrotnie nazwę funkcji, a następnie naciśnij + option+/


1
czy możesz to uruchomić? Nie mogę. Jeśli możesz; co wybierasz, używając polecenia? Wypróbowałem prawie każdą opcję ...
Confused Vorlon

2
Po prostu umieszczam kursor gdzieś w nazwie metody, a następnie wciskam polecenie + opcja + "/" (a także wybrałem "Edytor" - "Struktura" - "Dodaj dokumentację") w Xcode 8 i działa dobrze. Jedyny problem, jaki napotkałem do tej pory, to to, że wydaje się być mylony z @IBActionmetodami. Ale działa dobrze zarówno z Objective-C, jak i Swift. Jeśli nadal masz problemy i wypróbowałeś zwykłą, kiepską procedurę ponownego uruchamiania Xcode i / lub ponownego uruchamiania komputera, możesz po prostu opublikować raport o błędzie dotyczący tego oprogramowania w wersji beta.
Rob

2
Właśnie próbowałem zrestartować komputer, ale nadal bez radości. Przesłałem raport o błędzie.
Confused Vorlon

5
W rzeczywistości działa od wersji Xcode 8 beta 1, ale jeśli używasz El Capitan, musisz uruchomić Xcode, pozwolić mu zainstalować wymagane składniki systemu, a następnie uruchomić sudo /usr/libexec/xpccachectlw Terminalu i ponownie uruchomić komputer Mac, zanim to zrobi lub inne rozszerzenia Xcode praca. Zobacz informacje o wersji Xcode 8.
Chris Hanson,

1
Uważam, że działa sporadycznie. Czasami działa świetnie, a innym razem wcale. Nie odkryłem też, dlaczego. Szczerze mówiąc, kiedy to działa, uważam, że rzeczy, które generuje automatycznie, są raczej rzadkie (nazwa metody w opisie?). Dla tych z Was, że działa bez problemu, super. Dla niektórych z nas jest to sporadyczne lub po prostu nie działa.
Lloyd Sargent

7

Jest to najprawdopodobniej związane z faktem, że WSZYSTKIE klawisze skrótu z '/' nie działają w obecnej kompilacji XCode 8, jeśli twoja klawiatura wymaga naciśnięcia klawisza Shift, aby ją uzyskać.

To znaczy na niemieckiej klawiaturze '/' to shift + 7, naciśnięcie alt + cmd + shift-7 nic nie robi. Jeśli przypiszesz np. Cmd + shift + opt + d, to działa dobrze.

Skrót „///”, który niestety również teraz nie działa, jest prawdopodobnie spowodowany starą wtyczką XCode VVDocumenter, która używała dokładnie tego skrótu.

Świetna funkcja, kiepska kontrola jakości po stronie Apple.


Wystąpił ten błąd w Xcode 8 beta, ale został on naprawiony w wydanej wersji.
Eric Aya,

8A218a to wydana wersja - a skrót komentarza znów działa u mnie (nie w wersji beta).
Eric Aya

Czy korzystasz z układu klawiatury, w którym dostajesz „/” bez użycia shift?
Klaus Busse,

Tak, mam dwie klawiatury, jedną francuską Azerty z „/” na górze „:” i amerykańską Qwerty. Oba działają dobrze dla skrótu komentarza.
Eric Aya

Cóż, u mnie jest przerywany (klawiatura amerykańska).
Lloyd Sargent
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.