Jak działa nowe przetwarzanie dokumentacji Xcode 5?

Question

Zauważyłem, że Xcode 5 teraz automatycznie analizuje dokumentację metody. Na przykład:

/** 
Fetches a conversation with user. 

@param user The other user in the conversation. 

@return A conversation 
*/ 
+ (Conversation *)conversationWithUser:(User *)user; 

Obsługuje wiele @ znaki (nie wiem jak to nazwać). Na przykład:

• @warning
• @note

Jednak ja nadal nie znaleźli sposób lub w jakim formacie jest to tak, że mogę dodać odważne tekst lub kursywy lub linki.

Czy ktoś wie, jaki to format dokumentacji?

Answer 1

Zgodnie z nowymi funkcjami w Xcode 5 (poniżej Dokumentacji):

dokumentacji projektowej z dokumentacją ramy odniesienia API i strukturyzowanych komentarzy w swoim własnym kodem źródłowym są wyświetlane w panelu szybkiego pomocy w kodzie popover zakończenia realizacji. Komentarze strukturalne Doxygen i HeaderDoc są obsługiwanymi formatami.

Możesz sprawdzić Header Doc User guide.

Najwyraźniej używa podzestawu tych funkcji, wiele z nich nie działa.

Answer 2

To nie jest kompletne. W tej chwili nie obsługuje wszystkich tagów doxygen - tylko podstawowy podzestaw.

W międzyczasie, można użyć flagi jak -Wdocumentation i -Wdocumentation-unknown-command (lub lepiej, zacznij -Weverything i zmniejszyć) i brzęk powiadomi Cię, jeśli napotka coś, co jest nierozpoznane lub zniekształcone. Jeśli chcesz uzyskać pełną listę dostępnych znaczników, sprawdziłbym bagażnik.

Answer 3

Dowiedziałem się, jak uzyskać pogrubienie i kursywa. Używa on this Doxygen format. Nie wydaje się, aby rozpoznać wszystkie polecenia, ale niektóre prace:

/** 
Resumes \b network operation queues. 
*/ 
- (void)resume; 

\b nie uczyniłoby sieć pogrubione. \a podaje kursywę i \c tekst o stałej szerokości.