Comentarios

Los comentarios de un programa miden, de alguna forma, la calidad del código que se ha escrito. No seas parco o parca en palabras.

Se debe poner un comentario:

  • Al principio de cada archivo, con la descripción y objetivo del mismo.
  • Antes de cada método, explicando para qué sirve.
  • Antes de cada algoritmo, explicando que hace el algoritmo.
  • Antes de cada definición de estructura de datos, indicando cuál es su objetivo.
  • Antes de cada parte significativa del programa.

Los comentarios deben ir precedidos por una línea en blanco para separarlos lógicamente de la parte precedente del programa.

Existen varias formas de escribir comentarios:

  • Comentario multilínea: En este caso, cada línea debe ir precedido por el carácter “*”, excepto la primera y última línea, que contendrían los símbolos de principio y fin de comentario, respectivamente.

/**
* Esto es un comentario de un método
* que sigue a continuación y donde se cuenta
* para qué sirve dicho método
*/

  • Los comentarios en una línea deben ir sangrados (indentados) al mismo nivel que el código que comentan

/* Se comprueba si devuelve un 3 o no*/
if(funcion(unaVariable)==3){
haceAlgo();
}else{
haceOtraCosaDistinta();
}

  • Comentarios al final de la línea. Si se utilizan, deben ir suficientemente separados para distinguirlos como algo aparte del código.

if(funcion(unaVariable)==3){
haceAlgo();            //si la función devuelve 3
}else{
haceOtraCosaDistinta();
}

  • Comentarios hasta el final de la línea: Anteponiendo el símbolo “//”. No se recomienda para comentar varias líneas seguidas. En el ejemplo se muestran dos formas de usar este comentario. Utiliza una sola forma de manera consistente a lo largo de todo un programa.

if(funcion(unaVariable)==3){
haceAlgo(); //si la función devuelve 3
}else{
//Hace algo si no devuelve 3.
haceOtraCosaDistinta();
}

 

Anuncios

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s