2016-05-05 3 views
2

Im Grunde schreibe ich ein Programm, das viele trigonometrische und mathematische Manipulationen beinhaltet, die später überprüft werden müssen. Es ist schwierig zu erklären, was in diesem Abschnitt des Codes mit Wörtern passiert. Ich frage mich, ob es möglich ist, ein Diagramm in den Kommentaren des Codes hinzuzufügen, um eine Erklärung zu erleichtern?Ist es möglich, Bilder zu den Kommentaren des Codes in Swift hinzuzufügen?

Danke!

+1

Siehe [diese Frage] (http://stackoverflow.com/questions/24047991/does-swift-have-documentation-comments-or-tools). –

+1

Und siehe [diesen Link] (https://developer.apple.com/library/mac/documentation/Xcode/Reference/xcode_markup_formatting_ref/Images.html#//apple_ref/doc/uid/TP40016497-CH17-SW1) zum offizielle Apple-Dokumentation. –

Antwort

0

Wenn Sie Ihren Code als Xcode-Spielplatz versenden, können Sie Ihre Kommentare als Rich Text mit Markdown-Formatierung formatieren und Hyperlinks und Bilder hinzufügen. (Ein Spielplatz ist ein Dateipaket - ein Ordner, der wie eine einzelne Datei aussieht - so können Sie Ihre Bilddateien hineinlegen und auf die Playground-Quelle verweisen, und sie werden inline mit dem Rest Ihres Markups rendern.)

Wie in Kommentaren erwähnt, hat Apple docs erklärt die Formatierung von Kommentaren für Bilder und andere Markup.