SwiftDocAutomator

Swiftdocautomator

Swiftdocautomator - это мощный инструмент, который автоматически генерирует комментарии документации для вашего кода Swift, следуя официальным руководящим принципам Apple и Swift. Это поможет вам сэкономить время и усилия, анализируя ваш код и создавая краткую, простой для понимания документацию.

Функции

• Автоматически генерирует комментарии документации для функций и свойств Swift
• Следует официальным руководствам Apple и Swift для документации
• Поддерживает сводки класса и функции
• Легко интегрироваться в свой существующий рабочий процесс

Установка

Чтобы установить Swiftdocautomator, просто клонируйте репозиторий и установите требуемые зависимости:

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

Использование

Чтобы использовать Swiftdocautomator, запустите следующую команду:

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

Это генерирует комментарии документации для всех функций и свойств в указанном файле Swift, следуя официальным руководящим принципам Apple и Swift.

Пример

Предположим, у вас есть следующая функция 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 будет генерировать следующий комментарий документации:

 /// 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. Ваша отзывы ценны для меня, и я ценю любой вклад, который вы можете предоставить.

Лицензия

Swiftdocautomator выпускается по лицензии MIT. См. Файл лицензии для получения дополнительной информации.