Comentarios
Habrás notado estas líneas:
|
// vidas al inicio del juego // el jugador pierde una vida // el jugador recoge una vida extra |
Cuando pones dos barras inclinadas así // y un texto a continuación, estás dejando un comentario explicativo. Zig ignora esas líneas al compilar, pero a tu yo del futuro (y a cualquiera que lea tu código) le estarás haciendo un gran favor. Dentro de unos días, cuando ya no recuerdes con tanta claridad qué hacías, esos comentarios pueden ahorrarte mucho tiempo. Es una buena práctica comentar el código. Aunque también te recomiendo que, si el comentario es muy extenso, puede ser que estás siendo demasiado explícito, o bien que el código es demasiado complejo. Tal vez los nombres de las variables, constantes y funciones no están siendo autoexplicativos. Si es así, considera simplificar o replantear cómo estás haciendo las cosas. No te preocupes: esto de modificar y replantear el código fuente le pasa a todo el mundo. La programación es un proceso iterativo.
Si en cambio escribes unos comentarios así:
|
/// Este programa intenta adivinar /// el futuro de la humanidad, por lo tanto... |
o así:
|
//! Este es otro intento más de hacer el programa //! que adivina el futuro de la humanidad. El anterior fue un fracaso //! pero estoy seguro que esta vez... |
Zig los emplea para generar la documentación automática, mediante su sistema de build, que veremos en uno de los últimos capítulos del libro. Además, este tipo de comentarios solo puedes escribirlos en lugares muy concretos del código, así que, por ahora, los dejamos aparcados.