Comentar codigo

En este blog mostraré como comentar en el código en c++; para empezar es importante saber la utilidad de comentar nuestro código, puede servirnos para recordar la función de cada parte de nuestro código, la función del mismo programa o incluso nos puede servir momentáneamente para probar otras lineas de código, debido a que cualquier cosa que este marcada como comentario, no afecta al programa ya que no se ejecutan los comentarios. El hecho de comentar para que sirven ciertas lineas o funciones es particularmente útil cuando nuestro código es muy largo y también resulta muy útil cuando se trabaja en equipo, o cuando queremos compartir nuestro código con cualquier persona, ya que no tendrán que investigar para que sirve cada línea.

Ahora, existen dos formas de comentar tu código, una es poniendo «//» al principio de la línea, cabe mencionar que este tipo  de comment solo sirve para una línea, pero también puedes comentar poniendo «/*» al principio de tu comentario y cerrarlo de esta forma «*/» cabe mencionar que este tipo de comentario puede abarcar todas las lineas que quieras.

Esto no lleva a otra parte importante a la hora de escribir código, que es el estilo de programación, en esto entra el orden, la legibilidad, la forma en que nombras tus variables y los mismos comentarios. Lo ideal, evidentemente es ser ordenados a la hora de escribir código, ya que en caso de un error o modificación, no tendremos mayor problema en ubicarnos en nuestro código y en definitiva, es mas fácil encontrar  errores en códigos ordenados.

Por ejemplo, es mil veces recomendable escribir en forma de lista que en forma horizontal como en el siguiente ejemplo:

NO RECOMENDADO = numero1 = 1; numero2 = 4; numero 3 = 6;

RECOMENDADO = numero 1 = 1;

numero2 = 4;

numero3 = 6;

En el ejemplo anterior, encontramos que sería mas fácil encontrar, por ejemplo, un punto y coma faltante que en el ejemplo no recomendado. Sin embargo, esto es cuestión de gustos y el punto es escribir de la forma que se te haga mas practica.