Consejos para programar variables y nombres de funciones en su BeagleBone

Muy pocos programas funcionan sin variables, y los que lo hacen resultan en grandes líos. Aunque los nombres de las variables son arbitrarios, es de gran ayuda utilizar nombres autoexplicativos como los siguientes:

  • led para contener el nombre del pin que estás usando para encender un LED, como “USR3” o “P9_14”

  • estado para una variable que se mantenga ALTA o BAJA

  • b para un objeto de módulo BoneScript

  • botón para un pin de entrada al que está conectado un botón, como “P8_12”

  • dutyCycle para una variable que contiene el valor del ciclo de trabajo de un pin de salida de modulación de ancho de pulso (PWM)

Imagínese abrir su código dos meses después de haberlo escrito o entregárselo a otra persona. ¿Comprendería usted o la otra persona fácilmente lo que representa cada variable? A menos que tenga una memoria excepcional, le recomendamos encarecidamente que emplee esta técnica en su código.

Además, puede utilizar varias convenciones para los nombres de funciones y variables. Debería adoptar una convención y usarla en todos sus programas para evitar algunos errores bastante molestos. Es bastante común declarar una variable como dutycycle y luego escribir duty_cycle o dutyCycle en otro lugar de su código.

JavaScript y Python son lenguajes que distinguen entre mayúsculas y minúsculas, por lo que esta entrada sería un error. Aunque este tipo de error es fácil de detectar, corregirlo es una pérdida de tiempo innecesaria. A continuación se muestran las dos convenciones más utilizadas para nombrar variables:

  • Caso Camel: esta convención se usa comúnmente con las funciones predefinidas de JavaScript, y se prefiere cuando se programa en BoneScript. Todas las palabras después de la primera deben tener letras mayúsculas. Usando esta convención, ingresaría inputPin en lugar de inputpin .

  • Guiones bajos: esta convención se utiliza en las funciones predefinidas de muchos lenguajes de programación, incluido Python. Las palabras que componen los nombres de las variables están separadas por guiones bajos, así: input_pin .

Algunas personas prefieren la convención de guiones bajos, la razón por lo general es que un guión bajo tiene más sentido como reemplazo de un espacio y hace que la variable sea más legible. Por otro lado, algunas personas prefieren la convención de caso camel porque es más rápido de escribir (menos pulsaciones de teclas) y (en nuestra opinión) se ve más elegante. Siga la convención que prefiera, o simplemente use la misma que las funciones predefinidas del idioma que está usando.

LEER  Las herramientas adecuadas para trabajar en sus proyectos BeagleBone

A continuación se muestran algunas otras convenciones para nombrar variables:

  • índice para una variable que indica el índice de una matriz o una lista.

  • i para bucles, j para un bucle dentro de un bucle y k para un bucle dentro de un bucle dentro de un bucle. Además, estas variables se utilizan a menudo como índices de matrices o listas cuando las instrucciones relacionadas con la matriz o la lista están dentro de bucles.

  • aux , tmp y temp para variables auxiliares o temporales que se usan para contener un valor que se colocará en otra variable más adelante; no puede intercambiar el valor de dos variables sin usar una tercera, por ejemplo.

  • n y contar para las variables que cuentan el número de veces que algo sucede.

Mantenga los nombres de las variables cortos, pero no los acorte tanto que se vuelvan ilegibles. El uso de tmp o temp como temporal es justificable; el uso de iPin en lugar de inputPin puede generar confusión.

El uso de nombres que de alguna manera expliquen la función de la variable o la función, así como las convenciones siguientes, hace que cambiar partes de su código sea un proceso más rápido.

No es necesario definir una variable para tratar con el estado de un pin; podría utilizar “P9_14” todo el tiempo en lugar de definir led = “P9_14” . Si decide cambiarlo al pin P8_12 por cualquier motivo, como si nota que P9_14 ya se está utilizando para otra tarea, debe cambiar todas las líneas de su código en lugar de solo una.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *