DEV Community

Cover image for Buenas pr谩cticas al escribir c贸digo #1, - 2 consejos.
Ver贸nica Guam谩n
Ver贸nica Guam谩n

Posted on • Updated on

Buenas pr谩cticas al escribir c贸digo #1, - 2 consejos.

馃鈥嶐煉籄l 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;
        }
    }
Enter fullscreen mode Exit fullscreen mode

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;
        }
    }
Enter fullscreen mode Exit fullscreen mode

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.
Alt Text

Discussion (0)