AppleDoc und Swift

Diese Seite verwendet Cookies. Durch die Nutzung unserer Seite erklären Sie sich damit einverstanden, dass wir Cookies setzen. Weitere Informationen

  • AppleDoc und Swift

    Hi,

    Wie dokumentiert ihr euren Code ? Wenn ich mit Objective-C programmiere, verwende ich AppleDoc, was prima funktioniert. Das kann aber kein Swift.
    Die Dokumentation im Code, die man mit ALT+Klick bekommt, ist auch kein Thema. Da kann man recht gut dokumentieren:


    Quellcode

    1. /// Beschreibung
    2. ///
    3. /// :param: ein Parameter
    4. /// :returns: der Rückgabewert
    Das ist aber nicht die Dokumentation, die man über "Help -> Documentation and API Reference" bekommt. Die kann AppleDoc für Objective-C und ab der "irgendwann mal erscheinenden Version 3.0" auch für Swift. Nur wie bis dahin dokumentieren ?
    Googlen bringt auch nichts wirklich sinnvolles.
    Es gibt zwei Dinge, die sind unendlich. Das Universum und die menschliche Dummheit. Wobei beim Universum bin ich mir nicht sicher - Albert Einstein

  • Dokumentation für mich :)

    Damit ich bei größer werdenden Projekten nicht im Quellcode scrollen muss, um z.B. zu sehen, welche Methoden es gibt, was die tun und wozu die Parameter sind. Klar sind die Namen selbsterklärend, aber das behebt nicht das Problem, dass man nicht mehr weiß, welche Methoden da überhaupt implementiert sind.
    Die AppleDoc Doku ist durchsuchbar und man kann Aufrufbeispiele hinterlegen. Das geht alles im Code, aber der wird dann unübersichtlich.

    Ausserdem gehört es sich, auch kleine Projekte sauber zu dokumentieren :)
    Es gibt zwei Dinge, die sind unendlich. Das Universum und die menschliche Dummheit. Wobei beim Universum bin ich mir nicht sicher - Albert Einstein

  • Ja, in der Art mache ich es ja. Die Option+Click Anzeige sprich Quickhelp geht auch sauber. Damit ist zumindest beim Programmieren im gleichen Projekt alles dokumentiert. Wenn man aber viele Projekte hat, dann hilft das leider nicht. Bevor ich eine Methode neu schreibe, würde ich gerne irgendwo nachsehen, ob ich die oder eine ähnliche schon irgendwann mal geschrieben habe und mich da bedienen kann. Und ein grep über alle Sourceverzeichnisse ist nicht wirklich praktikabel ;)

    Doxygen sieht vielversprechend aus, aber leider auch kein Support für Swift für die "Documentation and API Reference".

    Wenn alle Stricke reissen, bau ich mir das selbst :) Ist ja nur ein Parsen von Textfiles und Erzeugen von HTML. Perl oder Python können das problemlos :) Dann liegt die Dokumentation halt statt im entsprechenden XCode auf meinem internen Webserver. Ist letztendlich ja egal.
    Es gibt zwei Dinge, die sind unendlich. Das Universum und die menschliche Dummheit. Wobei beim Universum bin ich mir nicht sicher - Albert Einstein

  • FWerewolf schrieb:

    Ja, in der Art mache ich es ja. Die Option+Click Anzeige sprich Quickhelp geht auch sauber. Damit ist zumindest beim Programmieren im gleichen Projekt alles dokumentiert. Wenn man aber viele Projekte hat, dann hilft das leider nicht. Bevor ich eine Methode neu schreibe, würde ich gerne irgendwo nachsehen, ob ich die oder eine ähnliche schon irgendwann mal geschrieben habe und mich da bedienen kann. Und ein grep über alle Sourceverzeichnisse ist nicht wirklich praktikabel ;)

    Doxygen sieht vielversprechend aus, aber leider auch kein Support für Swift für die "Documentation and API Reference".

    Wenn alle Stricke reissen, bau ich mir das selbst :) Ist ja nur ein Parsen von Textfiles und Erzeugen von HTML. Perl oder Python können das problemlos :) Dann liegt die Dokumentation halt statt im entsprechenden XCode auf meinem internen Webserver. Ist letztendlich ja egal.
    Wer XCode, xCode, X-Code oder alles andere != Xcode schreibt, muss ins Heim. Wenn nicht sogar ins Lattenheim. Oder gar nach Bodensee in ein Pfahldorf, wo ihm die Latte ordentlich vergällt wird! ;) (c) by Helge Schneider

  • Siehe hier.

    Quellcode

    1. /**
    2. Initializes a new bicycle with the provided parts and specifications.
    4. :param: style The style of the bicycle
    5. :param: gearing The gearing of the bicycle
    6. :param: handlebar The handlebar of the bicycle
    7. :param: centimeters The frame size of the bicycle, in centimeters
    9. :returns: A beautiful, brand-new, custom built just for you.
    10. */

    Quellcode

    1. /// The number of trips travelled by the bicycle.
    2. private(set) var numberOfTrips: Int

    Quellcode

    1. /**
    2. Hardware used for steering.
    4. - Riser: A casual handlebar.
    5. - Café: An upright handlebar.
    6. - Drop: A classic handlebar.
    7. - Bullhorn: A powerful handlebar.
    8. */
    9. enum Handlebar {
    10. case Riser, Café, Drop, Bullhorn
    11. }
    Alles anzeigen
    MARK / TODO / FIXME geht übrigens auch.

    Dieser Beitrag wurde bereits 5 mal editiert, zuletzt von Tecalto ()

  • Den Link kenn ich schon. Aber er hilft auch nur bei Quickhelp, nicht bei der Doku, die in "Documentation and API Reference" steht.

    Ich bau mir gerade etwas, was das machen wird :D

    Und Klaus mag wohl niemand :D
    Es gibt zwei Dinge, die sind unendlich. Das Universum und die menschliche Dummheit. Wobei beim Universum bin ich mir nicht sicher - Albert Einstein