Histórico da Página

Leer comentarios requiere tiempo, atención y ocupa cierto espacio de la pantalla. Por ello, es importante evitar comentarios inútiles que sólo confunden.

Deben evitarse comentarios que no aportan ninguna información o no ayudan a entender el código.

No se comentan acontecimientos que pueden identificarse fácilmente con la simple lectura del propio código. En este caso se define "fácil" cuando el tiempo necesario para entender el código es el mismo o menor que el tiempo necesario para leer el comentario.

 Ejemplo:

//Definición de la clase Cuenta
Class Cuenta
Method New() Constructor // Constructor de la clase
Method SetSaldo(nValor) // Modifica el saldo de la cuenta
Method GetSaldo() // Retorna el saldo de la cuenta
ENDCLASS
Los comentarios anteriores no aportan ninguna información que no pueda deducirse fácilmente con la lectura del propio código.
Sin embargo, algunas veces el código no es tan simple. En estos casos, incluso un comentario que no aporte ninguna información nueva puede ser útil, para facilitar la comprensión del código que no es tan obvio.
Ejemplo:
// Posición de la observación en el array
Local nPosOBS := AScan(aHeader, {|x| AllTrim(x[2]) == "ADF_OBS"})

Los comentarios tampoco deben utilizarse para disimular un código mal hecho o o soluciones informales. En lugar de eso, arregle el código.