SwiftDocAutomator

SwiftDocautomator

SwiftDocAutomator adalah alat yang ampuh yang secara otomatis menghasilkan komentar dokumentasi untuk kode Swift Anda, mengikuti pedoman Apple dan Swift resmi. Ini membantu Anda menghemat waktu dan upaya dengan menganalisis kode Anda dan menghasilkan dokumentasi yang ringkas dan mudah dipahami.

Fitur

• Secara otomatis menghasilkan komentar dokumentasi untuk fungsi dan properti Swift
• Mengikuti pedoman resmi Apple dan Swift untuk dokumentasi
• Mendukung ringkasan kelas dan fungsi
• Mudah diintegrasikan ke dalam alur kerja yang ada

Instalasi

Untuk menginstal SwiftDocAutomator, cukup klon repositori dan instal dependensi yang diperlukan:

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

Penggunaan

Untuk menggunakan SwiftDocAutomator, jalankan perintah berikut:

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

Ini akan menghasilkan komentar dokumentasi untuk semua fungsi dan properti dalam file Swift yang ditentukan, mengikuti pedoman Apple dan Swift resmi.

Contoh

Misalkan Anda memiliki fungsi Swift berikut:

 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 akan menghasilkan komentar dokumentasi berikut:

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

Berkontribusi

Saya senang menerima kontribusi apa pun yang mungkin Anda miliki. Jika Anda memiliki saran, laporan bug, atau permintaan fitur, jangan ragu untuk membuka masalah di repositori GitHub. Umpan balik Anda sangat berharga bagi saya dan saya menghargai masukan apa pun yang dapat Anda berikan.

Lisensi

SwiftDocautomator dirilis di bawah lisensi MIT. Lihat file lisensi untuk informasi lebih lanjut.