SwiftDocAutomator

SwiftDocautomator

O SwiftDocautomator é uma ferramenta poderosa que gera automaticamente comentários de documentação para o seu código SWIFT, seguindo as diretrizes oficiais da Apple e Swift. Ajuda a economizar tempo e esforço, analisando seu código e produzindo documentação concisa e fácil de entender.

Características

• Gera automaticamente comentários de documentação para funções e propriedades SWIFT
• Segue as diretrizes oficiais da Apple e Swift para documentação
• Suporta resumos de classe e função
• Fácil de integrar ao seu fluxo de trabalho existente

Instalação

Para instalar o SwiftDocautomator, basta clonar o repositório e instalar as dependências necessárias:

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

Uso

Para usar o SwiftDocautomator, execute o seguinte comando:

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

Isso gerará comentários de documentação para todas as funções e propriedades no arquivo SWIFT especificado, seguindo as diretrizes oficiais da Apple e Swift.

Exemplo

Suponha que você tenha a seguinte função 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 gerará o seguinte comentário de documentação:

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

Contribuindo

Fico feliz em receber quaisquer contribuições que você possa ter. Se você tiver alguma sugestão, relatórios de bug ou solicitações de recursos, sinta -se à vontade para abrir um problema no repositório do GitHub. Seu feedback é valioso para mim e eu aprecio qualquer entrada que você possa fornecer.

Licença

O SwiftDocautomator é liberado sob a licença do MIT. Consulte o arquivo de licença para obter mais informações.