Il a swift commentaires de documentation ou d’outils ?

Question

De nombreux langages prennent en charge les commentaires de documentation pour permettre à un générateur (comme `` ou doxygen), générer la documentation sur les codes en analysant le même code.

A Swift type commentaires de documentation ou d’outils de génération de documentation ?

Answer 1

Voici quelques éléments qui fonctionnent pour documenter le code swift dans Xcode 6. Il est très bogué et sensibles aux colons, mais c’est mieux que rien :

Ce qui précède est restitué dans l’aide rapide car vous prévoiriez avec mise en forme des listes numériques, puces, documentation de valeur de paramètre et retour.

Rien de tout cela est documenté - un Radar pour les aider le long du dossier.

Answer 2

SWIFT comprend « / / / » manipulation commentaire (bien que probablement pas tout encore).

Écrire quelque chose comme :

Puis option-clic sur le nom de func et voilà  :)

Answer 3

Je peux confirmer que ShakenManChild a fourni la solution peopr

Assurez-vous juste, que vous avez une ligne vide sous la description !

Answer 4

J’ai trouvé quelque chose d’intéressant, creusant dans les binaires de Xcode. Les fichiers avec la terminaison `` . Il a certainement des docs, parce que ces fichiers contiennent les docs pour la Swift UIKit / Fondation API, malheureusement, il semble être un format de fichier propriétaire, pour une utilisation dans la visionneuse de la Documentation dans Xcode.

Answer 5

C'est peut-être une bonne idée d'avoir un œil sur AppleDoc ou Apple HeaderDoc qui n'est pas reconnu beaucoup. Je peux encore trouver quelques HeaderDoc conseils en 10.9 Mavericks terminal (headerdoc2html)

Je vous recommande de lire le dernier "Quoi de neuf Dans Xcode"* (je ne sais pas si il est encore sous NDA) *Le lien pointe vers Xcode 5.1 version qui contient des infos sur HeaderDoc trop.