Para obtener más artículos, siga mi blog personal: https://seven777777.github.io/myblog/
Prefacio:
¿Nombras las variables como quieras durante el desarrollo?
Como programador con casi cuatro o cinco años de experiencia en codificación, a menudo tengo que enfrentarme a la denominación de varias clases, variables y funciones durante el proceso de desarrollo.
Aunque algunas reglas de nombres de estilo personal se han ido formando gradualmente a lo largo de los años, no se han convertido en un sistema relativamente estandarizado, por lo que en muchos casos son aún más informales.
Recientemente leí el capítulo sobre el poder de los nombres de variables en "Code Encyclopedia 2", así que seleccioné algunos puntos de conocimiento en el libro y los enumeré.
Creo que para los programadores con cierta experiencia, puede ayudarlos a reexaminar sus hábitos de codificación diarios y corregir algunos hábitos incorrectos; para los programadores novatos, pueden regularse en las primeras etapas para desarrollar un buen estilo de codificación.
En resumen, ¡este es un artículo útil!
Cosas a tener en cuenta al elegir buenos nombres de variables
Un buen nombre de variable es legible, fácil de recordar y apropiado.
Consideraciones de nomenclatura
Normalmente, la descripción de la variable es el mejor nombre de variable.
Longitud adecuada del nombre
Demasiado breve para transmitir suficiente información.
Demasiado largo, difícil de escribir y oscurece la estructura visual del programa.
El impacto de los nombres de variables en el alcance.
Los nombres más largos son adecuados para variables globales o variables poco utilizadas.
Los nombres más cortos son adecuados para variables locales o variables de bucle.
Sin embargo, como estrategia de programación defensiva, se deben evitar los nombres cortos de variables cuando sea posible.
Calificar nombres en el espacio de nombres global
Calificadores de valores calculados en nombres de variables
Para algunas variables que representan resultados de cálculo: total, promedio, máximo, etc., utilice calificadores similares a: Total, Suma, Promedio, Máx., Mín., Registro, Cadena, Puntero, etc. para modificar un nombre. El calificador debe ser The Se añade una palabra al final del nombre.
Tales como: ingresosPromedio, gastosTotal
La coherencia mejora la legibilidad y simplifica el mantenimiento.
Hay excepciones a la regla de poner cantidades calculadas después de sus nombres. La posición del clasificado de Num ya es convencional. Num se coloca al principio del nombre de la variable para representar un número total. Colocado en la posición final representa un subíndice.
- NumCustomers: representa el número total de empleados
- customerCount: representa el número total de empleados
- customerIndex: representa un empleado específico
Palabras contrastantes de uso común en nombres de variables
Mejore la legibilidad aplicando convenciones de nomenclatura para mejorar la coherencia en el uso de palabras contrastantes.
- comienzo/fin
- primero último
- bloqueado/desbloqueado
- mínimo máximo
- siguiente anterior
- viejo nuevo
- abierto/cerrado
- visible invisible
- origen Destino
- origen Destino
- arriba abajo
Nombrar tipos específicos de datos
subíndice de bucle
Nombres convencionales: i,j,k
Si la variable se va a utilizar fuera del bucle, se le debe dar un nombre más significativo.
Una denominación cuidadosa de las variables de índice de bucle puede evitar el problema común de la interferencia de índices: escribir i cuando te refieres a j y j cuando te refieres a i. También hace que el acceso a los datos sea más claro:
puntuación[teamIndex][eventIndex] proporciona más información que puntuación[i][j].
Variables de estado
Para mayor claridad, a las etiquetas se les deben asignar valores utilizando tipos de enumeración, constantes con nombre o variables globales utilizadas como constantes con nombre, y sus valores deben compararse con estas cantidades, por
ejemplo.
malo:
if(printFlag == 16)
bien:
if(reportType == ReportType_Annual)
Variables temporales
temperatura de uso común
Pero también puedes usar un nombre más descriptivo.
variable booleana
Nombres típicos de variables booleanas
- hecho significa que algo se ha completado
- error significa que ocurrió un error
- encontrado significa que se ha encontrado un valor
- Success/ok indica si la operación fue exitosa
Dar nombres a las variables booleanas que impliquen un significado verdadero/falso
A algunos programadores (incluido yo mismo) les gusta anteponer nombres de variables booleanas con is. Una de las ventajas de este enfoque es que no funciona con nombres oscuros: isStatus?
Una de las desventajas es que reduce la legibilidad de expresiones lógicas simples: if(isFound) es ligeramente menos legible que if(found)
Utilice nombres de variables booleanas positivas
Reducir el uso de nombres como: notFound, notDone...
son particularmente difíciles de leer, especialmente cuando están negados.
tipo de enumeración
Puede utilizar el prefijo de grupo, como Color_, Planet_ o Month_ para indicar claramente que los miembros de este tipo pertenecen a un grupo.
constante
Al nombrar una constante, el objeto abstracto debe nombrarse en función del significado representado por la constante, en lugar del valor numérico que tiene la constante. .
Cinco = 6,0 es ridículo.
Convención de nomenclatura informal
Directrices para convenciones de nomenclatura independientes del idioma
Distinguir entre nombres de variables y nombres de subrutinas
Los nombres de variables y objetos comienzan con una letra minúscula
Los nombres de las subrutinas comienzan con una letra mayúscula.
Distinguir entre clases y objetos.
Solución 1: Distinga tipos y variables comenzando con letra mayúscula
Widget widget
Solución 2: Distinguir entre tipos y variables con mayúsculas
WIDEGE widget
Opción 3: Distinguir tipos y variables agregando el prefijo t_ al tipo
t_Widget widget
Opción 4: Distinguir tipos y variables prefijando las variables con "a"
Widget aWidget
Solución 5: Distinga tipos y variables utilizando nombres más claros para las variables
Widget employeeWidget
- Identifica la variable global g_
- Variable miembro de identidad m_
- Declaración de tipo de identidad t_
- Identifica la constante nombrada c_
- Para identificar elementos de tipo de enumeración, agregue un prefijo de tipo específico, como por ejemplo: color_
- Marque parámetros de solo lectura en idiomas donde no se puede garantizar que los parámetros de entrada sean de solo lectura.
- Dar formato a los nombres para mejorar la legibilidad.
Dos métodos comunes: mayúsculas y minúsculas y delimitadores.
Directrices generales para abreviaturas
- Abreviaturas estándar (abreviaturas comunes enumeradas en los diccionarios)
- Eliminar todas las vocales no frontales (computadora->cmptr)
- Elimine las palabras de función y, o, el, etc.
- Utilice las primeras o las primeras letras de cada palabra.
- Truncar uniformemente después de la primera, segunda o tercera (elija la más apropiada) letra de cada palabra
- Mantenga la primera y la última letra de cada palabra.
- Utilice cada palabra importante del nombre, no más de tres.
- Elimine los sufijos inútiles ing, ed, etc.
- Conservar la pronunciación más notable de cada sílaba.
- Asegúrate de no cambiar el significado de la variable.
- Utilice las técnicas anteriores repetidamente hasta que la longitud de cada nombre de variable se reduzca a 8 ~ 20 caracteres o hasta que se alcance el límite de caracteres para nombres de variables en el idioma.
nombres para evitar
- Evite el uso de nombres o abreviaturas engañosas.
- Evite el uso de nombres con significados similares
- Evite el uso de variables con nombres similares que tengan significados diferentes
- Evite el uso de nombres que suenen similares entre sí.
- Evite el uso de números en los nombres
- Evite escribir mal palabras en los nombres
- Evita palabras que suelen estar mal escritas en inglés: Absense, acummulate, acsend…
- No distinga los nombres de las variables únicamente por mayúsculas y minúsculas
- Evite el uso de múltiples lenguajes naturales
- Evite el uso de nombres de tipo estándar, variables y subrutinas.
- No uses nombres que no tengan nada que ver con el significado de la variable
- Evite nombres que contengan caracteres confusos que dificulten la distinción entre pares:
- Número 1 y letra l minúscula
- Número 1 y letra L mayúscula
- .y,
- Cero 0 y letra O mayúscula
- 2 y Z
- :y;
- S y 5
- G y 6
