Objective-C Methodenbeschreibung (Dok-Kommentare)

Question

Ich lerne gerade Objective-C und muss wissen, wie man eine Methodenbeschreibung schreibt. Ich habe große Schwierigkeiten zu lernen, wie man das in Objective-C macht.

In Jave haben wir diese

/** 
<h2>MethodName</ h2 > 
<p>Various Description, can use html with images etc.</ p > 
*/ 
private void methodName(args[]..) 
{ 

} 

in Objective-C, wo ich die Beschreibung platzieren? Ist dies auch in der Header-Datei oder der Implementierungsdatei?

//Within Implementation? 
- (float)gteHeightPercentage:(float)percentageToGet 
{ 
    return self.view.bounds.size.height * percentageToGet; 
} 

//Within Header? 
- (float)getWidthPercentage:(float)percentageToGet; 

Answer 1

Aktualisierung: Das folgende Format funktioniert für Objc. Wenn Sie Swift-Code dokumentieren möchten, finden Sie unter NSHipster's blog about Swift Documentation

Der XCode 5 kann tun, was Sie wollen. Dank Wonil Kim, in der .h Datei:

/** 
* Add new message between source to destination timeline as empty name string 
* @author Wonil Kim 
* 
* @param sourceId Source timeline entity ID 
* @param destId Destination timeline entity ID 
* @return A newly created message instance 
*/ 
- (ISMessage*)messageFromTimeline:(NSInteger)sourceId toTimeline:(NSInteger)destId; 

Sobald dies erledigt ist, können Sie alt + Klick auf den Namen der Methode, und .. voilà!

Natürlich, wie Sie auf Kim's blog sehen können, ist dies nicht der einzige Weg:

/*! Some description of the method.... 
* \returns The result 
*/ 

Alternativ

/// Some description to show up, done by: 
/// @author Olly Dixon 

Sie haben den Punkt ...

Wie viele bereits erwähnt, Objective-C zeigt Ihnen nicht Ihre Dokumentation; in der Tat, auch nicht Java (Javadoc, möglicherweise).Es ist Ihre IDE, in diesem Fall der unzerbrechliche Xcode :)

UPDATE2:Complete list of "Special Commands" in comments.

UPDATE3: Verwenden VVDocumenter-Xcode wenn Sie möchten, dass durch /// automatische Generierung von Dokumentation ermöglichen.

Update4:: die Verknüpfung (⌥ Option + ⌘ Befehl + /)

Verwenden einer Dokumentation Kommentar zu Ihrem Code hinzufügen, wenn Sie Xcode verwenden 8: VVDocumenter hat in zu Xcode integriert werden oder über

Answer 2

Was Sie beschreiben, sind „Dokumentation Kommentare“ oder „doc Kommentare“ genannt kurz.

Xcode, ab Version 4.6.3, zeigt keine eigenen Dok-Kommentare in einem Popup-Fenster oder seinem Quick Help Inspector an. Sie müssen Ihre Kommentare in ein "Docset" kompilieren, um Xcode zur Anzeige zu bringen. Es gibt Tools, um das zu tun, aber es gibt keine Möglichkeit, Xcode dazu zu bringen, ein Docset neu zu laden, außer es zu beenden und neu zu starten, also empfehle ich nicht, sich zu ärgern.

Xcode 5 (derzeit als Entwicklervorschau für kostenpflichtige Mitglieder der OS X- und iOS-Entwicklerprogramme verfügbar) zeigt die Dok-Kommentare für Ihren eigenen Code an; siehe “Quick Help” on the Developer Tools Features page. Sie müssen die Dokumentkommentare in die Headerdatei schreiben. Sie können entweder das Doxygen- oder das Headerdoc-Format verwenden.

Answer 3

In objective-c wo stelle ich die Beschreibung?

Objective-C-Compiler wie gcc und llvm ist es egal, wie Sie Ihren Code dokumentieren. Es gibt verschiedene Dokumentationsgeneratoren wie Doxygen und HeaderDoc, die Dokumentation aus entsprechend formatierten Kommentaren erstellen können, normalerweise in Ihren Header-Dateien. Darüber hinaus erleichtert Xcode den Sprung zu der Definition von Symbolen, die in Ihrem Code definiert sind, und der Schnellhilfe-Inspektor kann Ihnen Definitionen anzeigen, und zwar ohne spezielle Anmerkungen in Ihrem Code.