Download SwiftDocAutomator - SwiftDocAutomator Quellcode Download

SwiftDocAutomator

Anderer Quellcode

1.0.0

Herunterladen

Swiftdocautomator

Swiftdocautomator ist ein leistungsstarkes Tool, das nach den offiziellen Richtlinien von Apple und Swift automatisch Dokumentationskommentare für Ihren Swift -Code generiert. Es hilft Ihnen, Zeit und Mühe zu sparen, indem Sie Ihren Code analysieren und präzise, leicht verständliche Dokumentation erstellen.

Merkmale

Generiert automatisch Dokumentationskommentare für Swift -Funktionen und Eigenschaften
Befolgen Sie die offiziellen Richtlinien für Apple und Swift für die Dokumentation
Unterstützt Klassen- und Funktionszusammenfassungen
Einfach in Ihren vorhandenen Workflow integrieren

Installation

Um Swiftdocautomator zu installieren, klonen Sie einfach das Repository und installieren Sie die erforderlichen Abhängigkeiten:

git clone https://github.com/Saik0s/SwiftDocAutomator.git
cd SwiftDocAutomator
pip install -r requirements.txt

Verwendung

Führen Sie den folgenden Befehl aus, um Swiftdocautomator zu verwenden:

python main.py /path/to/your/swift/file.swift

Dadurch werden Dokumentationskommentare für alle Funktionen und Eigenschaften in der angegebenen Swift -Datei gemäß den offiziellen Richtlinien von Apple und Swift generiert.

Beispiel

Angenommen, Sie haben die folgende schnelle Funktion:

 internal static func _typeMismatch ( at path : [ CodingKey ] , expectation : Any . Type , reality : Any ) -> DecodingError {
    let description = " Expected to decode ( expectation ) but found ( _typeDescription ( of : reality ) ) instead. "
    return . typeMismatch ( expectation , Context ( codingPath : path , debugDescription : description ) )
}

Swiftdocautomator generiert den folgenden Dokumentationskommentar:

 /// Returns a `.typeMismatch` error describing the expected type.
///
/// - parameter path: The path of `CodingKey`s taken to decode a value of this type.
/// - parameter expectation: The type expected to be encountered.
/// - parameter reality: The value that was encountered instead of the expected type.
/// - returns: A `DecodingError` with the appropriate path and debug description.

Beitragen

Ich bin froh, irgendwelche Beiträge zu erhalten, die Sie möglicherweise haben. Wenn Sie Vorschläge, Fehlerberichte oder Feature -Anfragen haben, können Sie bitte ein Problem im Github -Repository eröffnen. Ihr Feedback ist für mich wertvoll und ich schätze jede Eingabe, die Sie leisten können.