Dokumentacja szybkiej pomocy generowana automatycznie przez Xcode 8

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

„Automatycznie generuj dokumentację szybkiej pomocy”:

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.

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+/

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.