SwiftDocAutomator

Swiftdocatomator

SwiftDocatoMator는 공식 Apple 및 Swift 지침에 따라 Swift 코드에 대한 문서 주석을 자동으로 생성하는 강력한 도구입니다. 코드를 분석하고 간결하고 이해하기 쉬운 문서를 작성하여 시간과 노력을 절약 할 수 있습니다.

특징

• 신속한 기능 및 속성에 대한 설명서 주석을 자동으로 생성합니다
• 문서화에 대한 공식 애플 및 신속한 지침을 따릅니다
• 클래스 및 기능 요약을 지원합니다
• 기존 워크 플로에 쉽게 통합 할 수 있습니다

설치

SwiftDocatoMator를 설치하려면 저장소를 복제하고 필요한 종속성을 설치하십시오.

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

용법

SwiftDocatoMator를 사용하려면 다음 명령을 실행하십시오.

python main.py /path/to/your/swift/file.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 ) )
}

SwiftDocatomator는 다음 문서 주석을 생성합니다.

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

기여

나는 당신이 가질 수있는 어떤 기부금을 받게되어 기쁩니다. 제안, 버그 보고서 또는 기능 요청이 있으면 Github 저장소에서 문제를 열어주십시오. 귀하의 의견은 나에게 가치가 있으며 귀하가 제공 할 수있는 입력에 감사드립니다.

특허

SwiftDocatoMator는 MIT 라이센스에 따라 출시됩니다. 자세한 내용은 라이센스 파일을 참조하십시오.