Jak udekorować metody Celu C za pomocą dokumentacji?

Question

Kiedy piszę obiekt Cocoa i wywołuję selektor na tym obiekcie, czasami mogę zobaczyć "dokumentację" lub "pomoc" informacje o tej metodzie. Na przykład, gdy wpisuję [NSArray alloc], widzę dwie wskazówki pomocy. Jeden dla NSArray i jeden dla alloc. Oba te elementy pojawiają się w popup popup autouzupełnianie listy sugestii podczas wpisywania kodu.

Jak mogę uzyskać podobne wskazówki dotyczące stylu/klasy, które pojawią się po napisaniu? Chcę zobaczyć moje komentarze podczas wpisywania niestandardowej nazwy klasy i niestandardowych metod. Jak mogę to zrobić?

Na przykład C# udostępnia tę funkcję za pomocą dokumentacji XML, którą można umieścić przed deklaracją metody, klasy lub interfejsu/protokołu.

Answer 1

Musisz utworzyć "dokumentację". Istnieją narzędzia takie jak appledoc do tworzenia dokumentacji z komentarzy. Możesz ustawić fazę kompilacji, która uruchamia appledoc na twoim kodzie.

Problem polega na tym, że nie ma możliwości, aby Xcode 4 ponownie załadował dokument, z wyjątkiem ponownego uruchamiania Xcode. Więc nawet jeśli uruchomisz appledoc automatycznie jako część twojej kompilacji, będziesz musiał ponownie uruchomić Xcode, aby zobaczyć zmiany w twoim dokumencie.