Comentarios en Swift

¿Cómo se introducen comentarios en Swift?

Tenemos dos formas.

// Esto es una forma de introducir un comentario
/*Si queremos comentar más de una linea para explicar másy no alargar una linea 
*/

La longitud de un nombre de una variable debería ser proporcional a su alcance. La longitud de un nombre de una función o de una clase es la inversa.

En los lenguajes de programación antiguos, los nombres de las variables, funciones o clases estaban limitados con lo cual, teníamos que ir con cuidado y ser muy específicos. Pero, hoy en día, no tenemos dicha limitación. Por lo tanto, usémoslo.

// columns in table view ....
let columns: Int = 2
let columnsInTableView: Int = 2

Condiciones casi infinitas

No se recomienda usar condiciones complejas o condiciones largas. Podemos pensar que el hecho de que sea una condición así hace que una posible solución sea, poner un comentario.

// If both users are near and they have the same scoreif process(a, b) < .near && calculate(a) == calculate(b) {    doSometing()}
if bothUsersAreNearAndHaveSameScore() {
doSomething()
}func bothUsersAreNearAndHaveSameScore() -> Bool {
process(a, b) < .near && calculate(a) == calculate(b)
}

Entonces, ¿dónde podemos crear comentarios?

  • Si nuestro código es una librería que va a ser usado por un equipo externo al nuestro, te recomiendo que crees comentarios a modo de documentación para luego generarla.
/// This function calculate something  
///
/// - Parameters:
/// - name: The name of the function.
/// - request: The request.
func calculateSomething(name: String, request: [String: Any])
// MARK: - Life Cycle

¿Otros sitios?

Hay gente que le gusta poner ToDo. En general, un ToDo es algo que nunca lo harás, así que, en general, intenta no engañarte. Hoy en día, usamos más herramientas de documentación, aprovecha para poner esos ToDos en el backlog.

--

--

mobile developer

Love podcasts or audiobooks? Learn on the go with our new app.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store