Apr 15, 2015
Quick help (standard documentation) in Swift
Have you need to add standard documentation to your Swift code? Have you need to write a readable “Quick help” in Swift? Have you need to add comments to your Swift function?
That’s easy!
You can create a basic text comment observing this format :key:
/** My Function is a stupid function written in Swift (1.2) :param: param1 is a String param :param: param2 is a Int param :param: closure wow there is a closure! :returns: Always 2.0 :thisisacustomtext: Wow! 😃 availability iOS 8.3 */ class func myFunction(param1: String, param2: Int, closure: (Bool) -> Void) -> Float { println("This is a stupid func") return 2.0 }
Enjoy!