Jump to content


Photo

Que tamaño deben tener los nombres de variables?


  • Please log in to reply
23 replies to this topic

#21 Delphius

Delphius

    Advanced Member

  • Administrador
  • 6295 posts
  • LocationArgentina

Posted 14 December 2010 - 01:59 PM

Vaya Poliburro, me hiciste acordar que hace un buen tiempo quise llevar una nomeclatura similar a lo que describes: emplear una especie de sufijo que indique su visiblidad, tipo, etc.

Luego mi dije que eso es demasiado para mi... suficiente tengo con imaginarme prefijos para los componentes, que gracias a CnPack es casi automático. Más prefijos es para darme vuelta la cabeza.

Yo me acostumbré, o mal acostumbré, a nombrar las variables basado en el contexto y las referencias bibliográficas. Traslado la nomeclatura usada en los libros al código y en caso de que tenga que llevar mis propias variables la extraigo y las nombro según el contexto. Por ejemplo, hagamos de cuenta de estoy implementando una biblioteca para cálculos estadísticos. Por lo general el desvío estándar en los libros se simboliza con la letra sigma. Entonces yo a mis variables la nombro Sigma.

Ahora hagamos de cuenta de que tengo que implementar una función o un método que calcule el "Z" para una distribución normal estándar. El cálculo de la variable aleatoria normal estándar Z, como seguramente saben, responde a la división entre la diferencia del valor X y la media U respecto al desvío estándar. Entonces la función recibiría tres parámetros: Value, Mean y Std (de Standard Desviation):



delphi
  1. function StandarNormal(Value, Mean, Std: Double): Double;



Como se aprecia, nada de U, X, Z como se esperaría.

Sólo las variables internas a los métodos reciben el nombre según mis fuentes.

Así es como llevo mi nomeclatura.

Saludos,
  • 0

#22 Marc

Marc

    Advanced Member

  • Moderadores
  • PipPipPip
  • 1484 posts
  • LocationMallorca

Posted 14 December 2010 - 02:36 PM

Gracias por compartir tu mecánica de documentación, Delphius.
  • 0

#23 andres1569

andres1569

    Advanced Member

  • Miembro Platino
  • PipPipPip
  • 431 posts

Posted 14 December 2010 - 02:44 PM

En los programas suelo emplear el español para nombrar rutinas, también me gusta dar nombres descriptivos a casi todos los controles, aunque a veces tengo tal empanada que lo hago en spanglish (más o menos como decía JoAnCa), nombres como BtnAceptar, FMain, EditFiltro ... y mezclaillos poco recomendables, lo reconozco (todavía no me sale del alma nombrar FPrincipal)  :) :)

Pero las rutinas básicas, así como componentes propios, los hago ya siempre en inglés, además es una forma de en un futuro poder publicar o compartir dichas rutinas o componentes en la lengua por antonomasia de la programación y que todo programador al menos debe conocer (Delphius, mi traductor Inglés-Español antiguo pesaba unos 2 kg también, ahora tengo uno que está en los 3,5  :D ).

En cuanto a documentar, cada vez pongo más comentarios acompañando el código, sobre todo si sé que lo van a leer o puede ser útil a otros, como algunas rutinas que he puesto en estos foros. Sí lo tengo por norma en aquellos rutinas que es complicado entender por qué hice tal o cuál cosa, y siempre pongo una señal allá donde hay código que podría mejorar o que puede dar algún problemilla, y cuando quiero ponerme a corregir hago la búsqueda masiva de dicha señal.

Saludos


  • 0

#24 escafandra

escafandra

    Advanced Member

  • Administrador
  • 4107 posts
  • LocationMadrid - España

Posted 14 December 2010 - 03:32 PM

Yo tiendo a usar nombres descriptivos lo mas cortos posibles y en ingles, tanto para variables como para funciones.

No documento mucho el código. Suelo describir lo que hace una función en su cabecera y algún comentario interior si pienso que puede ser confuso de leer y está muy optimizado.

Por otro lado abuso de "cortar y pegar" a la hora de escribir mis variables y llamadas a función, siempre que puedo y me resulte más rápido/cómodo que teclear.


Saludos.
  • 0




IP.Board spam blocked by CleanTalk.