SwiftDocAutomator

Swiftdoocautomator

SwiftDocautomator es una herramienta poderosa que genera automáticamente comentarios de documentación para su código Swift, siguiendo las pautas oficiales de Apple y Swift. Le ayuda a ahorrar tiempo y esfuerzo analizando su código y produciendo documentación concisa y fácil de entender.

Características

• Genera automáticamente comentarios de documentación para funciones y propiedades rápidas
• Sigue las pautas oficiales de Apple y Swift para la documentación
• Admite resúmenes de clase y función
• Fácil de integrar en su flujo de trabajo existente

Instalación

Para instalar SwiftDocautomator, simplemente clone el repositorio e instale las dependencias requeridas:

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

Uso

Para usar SwiftDocautomator, ejecute el siguiente comando:

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

Esto generará comentarios de documentación para todas las funciones y propiedades en el archivo Swift especificado, siguiendo las pautas oficiales de Apple y Swift.

Ejemplo

Supongamos que tiene la siguiente función Swift:

 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 generará el siguiente comentario de documentación:

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

Que contribuye

Estoy feliz de recibir cualquier contribución que pueda tener. Si tiene alguna sugerencia, informes de errores o solicitudes de funciones, no dude en abrir un problema en el repositorio de GitHub. Sus comentarios son valiosos para mí y aprecio cualquier opinión que pueda proporcionar.

Licencia

SwiftDocautomator se libera bajo la licencia MIT. Consulte el archivo de licencia para obtener más información.