2015-12-02 8 views
6

Ich arbeite derzeit am Aufbau iOS SDK, geschrieben in Objective-C. Nun, da ich SDK getestet und bereit habe, möchte ich Dokumentation hinzufügen, die Swift und Objective-C kombiniert. Ich habe an folgenden Doc-Generator-Tools gearbeitetObjective-C und Swift Documentation zusammen wie Apple Dokumentation

a. Doxygen

b. AppleDoc

c. Jazzy

d. Apples HeaderDoc.

Ich möchte die Kommentare in meiner objective-c-Header-Datei verwenden und kombinierte Hilfe für Objective C und Swift ähnlich wie Apple in letzter Zeit tun. Meine Frage ist, wie erzeuge ich die Dokumentation für Swift und Objective-C aus Objective-C-Headern?

Hier sind einige Links auf der Grundlage meiner Forschung:

Danke,

Ram.

Bitte beachten Sie die Apple-Dokumentation hier:

image

+0

Es ist unklar, was Sie fragen. Sie möchten eine App mit Obj-c und swift erstellen? Was ist dann mit der Dokumentation? Warum meinst du überhaupt, "obj-c und swift" zu unterstützen? Das Ziel ist iOS. Es unterstützt beides. Das ist die ganze Sache dort ist – NSNoob

+1

Wenn Sie Obj-c-Dateien in einem schnellen Projekt verwenden möchten, sollten Sie dies lesen. https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html. Es ist möglich – NSNoob

+0

Vielen Dank für die schnelle Antwort. Ich möchte Doc-Sets erstellen, wie Apple seine APIs dokumentiert, die Dokumentation für Swift und Objective-C enthalten. Bitte beziehen Sie sich [hier] (https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSArray_Class/#//apple_ref/occ/instm/NSArray/componentsJoinedByString :) – Ram

Antwort

2

Vielleicht (noch) nicht genau das, was Sie suchen, aber Sie können Swiftify verwenden (https://objectivec2swift.com/) -Dienst Erklärungen zur Umwandlung von Objective-C zu Swift .

Darüber hinaus, wenn oben Dokumentationswerkzeuge erlauben, jede Art von Plugin zu entwickeln, mit zu integrieren, sollte es möglich sein, Swift-Quellen automatisch zu erzeugen, indem wir unsere verwenden.

Wir sind vielleicht bereit, eine solche Integration zu entwickeln, wenn es eine Nachfrage dafür geben wird.

Haftungsausschluss: Ich bin der Autor von Swiftify :)

+1

Vielen Dank für die wertvolle Antwort. Ich habe Swiftify ausprobiert. Es konvertiert Objective-C-Code in Swift perfekt, aber keine Dokumentation des Codes. Wenn Sie jedoch erwähnt haben, dass es eine Nachfrage geben wird, zählen Sie mich mit +1, um auf das Feature zu warten. – Ram