Automatyczne generowanie komentarza do metody w XCode

Question

Czy istnieje sposób w Xcode do generowania komentarza do metody automatycznie podobny do tego, co robisz w Eclipse dla komentarzy javadoc.

Np. Naciśnij przycisk możesz trafić/** jeden wiersz przed deklaracją metody, a zaćmienie automatycznie generuje szkielet komentarza metody.

Answer 1

Możesz użyć do tego biblioteki Code Snippets. Nie będzie automatycznie generował symboli zastępczych dla każdego parametru, ale mimo to jest całkiem przydatny. Oto co możesz zrobić:

1. Napisz gdzieś przykładowy blok komentarza w swoim kodzie.
2. Wstaw <#xyz#> gdzie chcesz umieścić symbol zastępczy "xyz". (Są jak zastępcze ukończenia parametr, dzięki czemu można w zakładce między nimi i zastąpić je.)

Na przykład:

/** 
* Method name: <#name#> 
* Description: <#description#> 
* Parameters: <#parameters#> 
*/ 

1. Otwórz prawicy pasek boczny. W dolnym okienku kliknij dwie nawiasy klamrowe, aby wyświetlić bibliotekę snippets.
2. Wybierz i przeciągnij tekst do biblioteki kodów fragmentów.
3. Stworzy nowy. Podwójne kliknięcie na nim, kliknij Edytuj w menu podręcznym, i nadać mu skrót zakończenia (np comblk za komentarz bloku.)

Teraz, po wpisaniu „comblk” w dowolnym miejscu w redakcji, popup Autouzupełnianie pojawia się i ty może uderzyć, aby powrócić do wklejenia w opisie. Zostanie wybrany pierwszy symbol zastępczy i możesz rozpocząć wpisywanie nazwy metody. Kliknij kartę, aby przejść do opisu i tak dalej.

Nie idealny, ale lepszy niż nic. Snippety to niezły pomysł, że Apple jeszcze nie ukończyło implementacji.

Answer 2

Możesz użyć tej niesamowitej wtyczki.

https://github.com/onevcat/VVDocumenter-Xcode

Answer 3

Można użyć skrótu do tworzenia nagłówka Doc:

⌘ + ⌥ + /

gdzie
⌘ = Komenda
= alt

Answer 4

1. Wybierz swój kod, dla których chcesz wygenerować komentarz i naciśnij klawisz skrótu

   CMD + ALT +/

2. Komentarz zostanie wygenerowaną automatycznie dla wybranej metody.