1. Utilice nombres de variable lo suficientemente cortos y largos en cada ámbito de código. En general, la longitud puede ser 1 carácter para contadores de bucle, 1 palabra para variables de condición / bucle, 1-2 palabras para métodos, 2-3 palabras para clases, 3-4 palabras para globales.
2. Utilice nombres específicos para las variables, por ejemplo “valor”, “igual”, “datos”, … no son nombres válidos para ningún caso.
3. Use nombres significativos para las variables. El nombre de la variable debe definir la explicación exacta de su contenido.
- Cómo saber si / cuándo puede aplicar la manipulación de bits para resolver un problema
- ¿Cómo calcular la permutación inversa en un estilo de programación funcional?
- ¿Qué es una lista vinculada en las estructuras de datos de programación?
- ¿Alguien puede compartir el conocimiento sobre el algoritmo de Monte Carlo que recoge datos al azar?
- ¿Es seguro decir que un algoritmo iterativo es mejor que el recursivo para el mismo problema dado que ambos son de la misma complejidad temporal?
4. No comience variables con o_, obj_, m_, etc. Una variable no necesita etiquetas que indique que es una variable.
5. Obedezca los estándares de nomenclatura de la compañía y escriba los nombres de las variables de manera consistente en la aplicación: por ejemplo, txtUserName, lblUserName, cmbSchoolType, … De lo contrario, la legibilidad se reducirá y las herramientas de búsqueda / reemplazo serán inutilizables.
6. Obedezca los estándares del lenguaje de programación y no use minúsculas / mayúsculas de manera inconsistente: por ejemplo, nombre de usuario, nombre de usuario, nombre de usuario, nombre de usuario m, nombre de usuario, …
– use Camel Case (también conocido como Upper Camel Case) para las clases: VelocityResponseWriter
– utilice mayúsculas y minúsculas (también conocido como minúsculas Camel Case) para las variables: studentName
– use mayúsculas para constantes: MAX_PARAMETER_COUNT = 100
– use Camel Case para nombres de clase enum y Mayúsculas para valores enum.
– no use ‘_’ en ninguna parte excepto constantes y valores de enumeración (que son constantes).
7. No reutilice el mismo nombre de variable en la misma clase en diferentes contextos: por ejemplo, en método, constructor, clase. Por lo tanto, puede proporcionar más simplicidad para la comprensión y el mantenimiento.
8. No use la misma variable para diferentes propósitos en un método, condicional, etc. Cree una nueva y diferente variable con nombre. Esto también es importante para la mantenibilidad y la legibilidad.
9. No utilice caracteres no ASCII en nombres de variables. Esos pueden ejecutarse en su plataforma pero no en otros.
10. No use nombres de variables demasiado largos (por ejemplo, 50 caracteres). Los nombres largos traerán código feo y difícil de leer, y es posible que no se ejecuten en algunos compiladores debido al límite de caracteres.
11. Decida y use un idioma natural para nombrar, por ejemplo, usar nombres mixtos en inglés y alemán será inconsistente e ilegible.
12. Use nombres significativos para los métodos. El nombre debe especificar la acción exacta del método y para la mayoría de los casos debe comenzar con un verbo. (por ejemplo, createPasswordHash)
13. Obedezca los estándares de nomenclatura de la empresa y escriba los nombres de los métodos de manera consistente en la aplicación: por ejemplo, getTxtUserName (), getLblUserName (), isStudentApproved (), … De lo contrario, la legibilidad se reducirá y las herramientas de búsqueda / reemplazo serán inutilizables.
14. Obedezca los estándares del lenguaje de programación y no use caracteres en minúscula / mayúscula de manera inconsistente: por ejemplo, getUserName, GetUserName, getusername, …
– use el caso mixto para los nombres de métodos: getStudentSchoolType
– use el caso mixto para los parámetros del método: setSchoolName (String schoolName)
15. Utilice nombres significativos para los parámetros del método, de modo que pueda documentarse en caso de que no haya documentación.
PD: Una vez que practique las pautas anteriores para parte de su código inicial, su proceso de pensamiento decide automáticamente qué nombre nombrar.
