SwiftDocAutomator

Swiftdocautomateur

SwiftDocautomator est un outil puissant qui génère automatiquement des commentaires de documentation pour votre code SWIFT, en suivant les directives officielles Apple et Swift. Il vous aide à gagner du temps et des efforts en analysant votre code et en produisant une documentation concise et facile à comprendre.

Caractéristiques

• Génère automatiquement des commentaires de documentation pour les fonctions et les propriétés rapides
• Suit les directives officielles Apple et Swift pour la documentation
• Prend en charge les résumés de classe et de fonction
• Facile à intégrer dans votre flux de travail existant

Installation

Pour installer SwiftDocAutomator, clonez simplement le référentiel et installez les dépendances requises:

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

Usage

Pour utiliser SwiftDocAutomator, exécutez la commande suivante:

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

Cela générera des commentaires de documentation pour toutes les fonctions et propriétés dans le fichier SWIFT spécifié, en suivant les directives officielles d'Apple et Swift.

Exemple

Supposons que vous ayez la fonction rapide suivante:

 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 générera le commentaire de documentation suivant:

 /// 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. 

Contributif

Je suis heureux de recevoir toutes les contributions que vous pourriez avoir. Si vous avez des suggestions, des rapports de bogues ou des demandes de fonctionnalités, n'hésitez pas à ouvrir un problème sur le référentiel GitHub. Vos commentaires sont précieux pour moi et j'apprécie toute contribution que vous pouvez fournir.

Licence

SwiftDocautomator est libéré sous la licence du MIT. Voir le fichier de licence pour plus d'informations.