Buenas prácticas al escribir código #1, - 2 consejos.

🧑‍💻Al programar debemos tomar en cuenta ciertas buenas practicas que nos ayudan a que el código sea más legible. 👩‍💻
Ya que en un futuro nuestro código va a ser leído por otros programadores, ya sea para mejorar funcionalidades, mantenimiento etc, o por ti mismo y si no aplicaste buenas practicas, podría darse que no reconozcas tu código después de un tiempo.

En esta ocasión te traigo dos buenas practicas, que aunque son básicas pueden ayudarte a mejorar la forma en la que estas escribiendo tu código.

1. Convenciones y Estándares de Nombres

En programación siempre trabajamos con nombres, ya sea nombres de variables, clases, métodos.
Para esto existen dos principales notaciones, Notación de Pascal y Notación de Camell.
Aquí te muestro como podemos aplicarlos.

Notación de Pascal
El primer caracter de cada palabra se escribe con mayúscula y el resto con minúscula. Es recomendable usarla para nombres de clases, métodos, atributos. Por ejemplo:

//Nombre de la clase
public class User
    {
        //Nombre de atributos
        public string DateRegistre { get; set; }
        //Nombre del Constructor
        public User()
        {

        }
        //Nombre de un Método
        public bool CreateUser(User user)
        {
            //Código
            return true;
        }
    }

Notación de Camell
La primera letra de la primera palabra o la primera palabra se escribe con minúsculas, las primeras letras de las siguientes palabras se escribe en mayúsculas y el resto con minúsculas.
esto puede parecer confuso pero básicamente es como escribimos variables, por ejemplo si una variable va a capturar el total de los usuarios puede llamarse así: totalUsers.
Es recomendable usarla en nombres de variables como mencione anteriormente, parámetros de métodos. Ejemplo

public class User
    {
        //Nombre de una variable
        int totalUser = 0;


        //Nombre del parámetro para un método
        public bool EditUser(int idUser)
        {
            //Código
            return true;
        }
    }

2. Comentarios

Aquí aplica el menos es más, en cuanto a los comentarios es recomendable usarlos solo en donde sea necesario, no es necesario escribir comentarios antes de cada método o antes de cada línea de código, porque el código debe ser descriptivo, los nombres de métodos, clases, variables etc.
Se debe colocar comentarios en donde sea necesario, y que aporte al código. (el ejemplo de comentarios en las líneas de código anterior seria una mala practica, pero los coloque para que se identifique en donde se aplica las notaciones de nombre, en otro caso no se los debe colocar porque los nombres ya explican por si solos la acción que va a realizar).

Tampoco es buena practica dejar pedazos de código comentado "por si acaso", tal vez ese método o las líneas que hemos comentado no lo vamos a usar más. es preferible borrarlos y dejar solo el código a utilizar.

Conclusión
Los nombres de que utilizamos al escribir código deben ser descriptivos, es decir que nos digan la acción que realiza o el objetivo que va a cumplir, evitar escribir variables monosílabas, métodos que no indiquen la función que van a cumplir etc, no podemos escribir string x = ""; porque no sabemos que significa x, o tal ves tu si pero al ser leído por alguien mas no lo va a entender.

En cuanto a los comentarios usa solo los comentarios necesarios

Por si te interesa he escrito la Segunda parte de esta serie de Buenas prácticas.

Nos vemos en Twitter e Instagram ;)

y como siempre te dejo una infografía con un resumen.