Foros del Web » Programando para Internet » Javascript »

La mejor forma de ordenar el código fuente para un buen entendimiento.

Estas en el tema de La mejor forma de ordenar el código fuente para un buen entendimiento. en el foro de Javascript en Foros del Web. Saludos! No he podido decidirme de cuál sería la mejor forma de escribir, con un buen orden, el código fuente de mis archivos javascript, como ...
  #1 (permalink)  
Antiguo 11/08/2011, 21:21
 
Fecha de Ingreso: julio-2011
Ubicación: Zapopan, Jal. MX
Mensajes: 316
Antigüedad: 12 años, 10 meses
Puntos: 32
Información La mejor forma de ordenar el código fuente para un buen entendimiento.

Saludos!

No he podido decidirme de cuál sería la mejor forma de escribir, con un buen orden, el código fuente de mis archivos javascript, como el espacio entre operadores, funciones, sententencias, parametros, variables, etc, etc. (ej. var a=1; ó var a = 1;).

Lo que quiero es la mejor forma para que incluso sea entendible para cualquier programador.

Para facilitar el tema, en seguida dejo el código fuente de un constructor para un objeto popup, el punto es que alguien con un poco de tiempo edite éste código fuente para que quede de la más agradable estructura, también pueden hasta cambiar las sentencias para simplificar el código o cambiarlas de posición.

Código Javascript:
Ver original
  1. // INICIO DEL CONSTRUCTOR
  2. var popup = function( WIDTH, HEIGHT ) {
  3.  
  4.     // Validación de las dimensiones del nuevo popup
  5.     if ( ! WIDTH || ! HEIGHT )
  6.         return false;
  7.     // Filtración para los parámetros
  8.     var width = Number( WIDTH );
  9.     var height = Number( HEIGHT );
  10.  
  11.     // Creación de los elementos del objeto popup
  12.     function dcE( width, height ) {
  13.         var element = document.createElement( "div" );
  14.         if ( width && height ) {
  15.             element.style.width = width + "px";
  16.             element.style.height = height + "px";
  17.         }
  18.         return element;
  19.     }
  20.     this.popup = dcE( width, height );
  21.     this.body = dcE();
  22.  
  23.     // Creación de un identificador para el elemento popup con variación de 0-65536 e inicial "popup"
  24.     do {
  25.         var newIdentifier = parseInt( Math.random() * Math.pow( 2, 16 ) ); // 0-65536
  26.     }
  27.     while( document.getElementById( newIdentifier ) );
  28.     this.popup.setAttribute( "id", "popup" + newIdentifier );
  29.  
  30. // FIN DEL CONSTRUCTOR
  31. };
  32.  
  33. // INICIO DEL PROTOTIPO
  34. popup.prototype = {
  35.  
  36. };
  37. // FIN DEL PROTOTIPO

Agradezco su pacienca y les deseo un buen día.

Última edición por IXtremeLT; 11/08/2011 a las 21:29
  #2 (permalink)  
Antiguo 11/08/2011, 21:50
Avatar de Aijoona
Colaborador
 
Fecha de Ingreso: mayo-2011
Ubicación: Buenos Aires
Mensajes: 779
Antigüedad: 13 años
Puntos: 343
Respuesta: La mejor forma de ordenar el código fuente para un buen entendimiento.

La pregunta es tan retorica como consultar sobre la mejor religion.

Convenciones oficiales no existen, tenés las de Crockford si te interesan:

Code Conventions for the JavaScript Programming Language
__________________
blog | @aijoona
  #3 (permalink)  
Antiguo 11/08/2011, 22:10
 
Fecha de Ingreso: julio-2011
Ubicación: Zapopan, Jal. MX
Mensajes: 316
Antigüedad: 12 años, 10 meses
Puntos: 32
Respuesta: La mejor forma de ordenar el código fuente para un buen entendimiento.

Esa comparación no me parece tan adecuada...
Nadamas con que alguien valíde la estructura y me diga si es mejor ponerlo de tal forma o así esta bien o que lo edite como mencioné anteriormente.
  #4 (permalink)  
Antiguo 12/08/2011, 01:11
Avatar de ceSharp  
Fecha de Ingreso: octubre-2008
Ubicación: Madrid
Mensajes: 495
Antigüedad: 15 años, 6 meses
Puntos: 66
Respuesta: La mejor forma de ordenar el código fuente para un buen entendimiento.

hola IXtremeLT,

como decía mi profesor de latín 'Cada maestrillo tiene su librillo'. Seguramente lo que a mi me parezca súper claro, a ti no te lo resulte tanto.
Pero por lo que que veo de tu código lo estructuras bastante bien; a mí por lo menos me resulta legible.
Yo lo que más valoro de un código, sobre todo cuando trabajas en equipo, es que esté bien comentado, explicando lo que consideres comprometido, fechando los cambios y con tu nombre, para que en todo momento se sepa quién y cuándo cambió esto o esto otro sin necesidad de recurrir a herramientas de históricos de modificación y cosas de esas.

saludos
  #5 (permalink)  
Antiguo 12/08/2011, 13:46
 
Fecha de Ingreso: julio-2011
Ubicación: Zapopan, Jal. MX
Mensajes: 316
Antigüedad: 12 años, 10 meses
Puntos: 32
Respuesta: La mejor forma de ordenar el código fuente para un buen entendimiento.

ceSharp gracias, es cierto, sucéde que yo jamás he tenído la oportunidad de trabajar en equipo sobre estas cosas y es por eso de mi post. Lo que tomaré mucho en cuenta es el punto dondé mencionas que es debe estár muy bien comentado, porque suele pasarme que cuando ya llevo unas 500 líneas, ya ni se como modificarlo porque no se dónde está cada cosa y que hace hehe, saludos y grax de nuevo.
  #6 (permalink)  
Antiguo 12/08/2011, 17:42
Avatar de MaBoRaK  
Fecha de Ingreso: abril-2003
Ubicación: La Paz - Bolivia
Mensajes: 2.003
Antigüedad: 21 años
Puntos: 35
Respuesta: La mejor forma de ordenar el código fuente para un buen entendimiento.

loading.......


Yo siempre he seguido el STYLE de Zend Framework, ya sea para PHP o JAVASCRIPT

http://framework.zend.com/manual/en/...ing-style.html

A esto debo a;adir:
- No mayusculas
- No LeTrAsDeEsTaFoRmA (lo use un tiempo pero luego vi que era desastrozo)
- El TAB de 4 espacios
- No operaciones del tipo:
while()
algo++
Usar llaves para todo.

Creo que eso es todo.


connection closed.
__________________

Maborak Technologies
  #7 (permalink)  
Antiguo 12/08/2011, 18:29
Avatar de Aijoona
Colaborador
 
Fecha de Ingreso: mayo-2011
Ubicación: Buenos Aires
Mensajes: 779
Antigüedad: 13 años
Puntos: 343
Respuesta: La mejor forma de ordenar el código fuente para un buen entendimiento.

Me causa un poco de gracia que el framework de la empresa que esta detrás de PHP use convenciones distintas a las del lenguaje.

Por otro lado, debo decir que no coincido con las llaves abajo.
__________________
blog | @aijoona

Etiquetas: codigo_agradable, codigo_entendible, codigo_fuente, codigo_ordenado
Atención: Estás leyendo un tema que no tiene actividad desde hace más de 6 MESES, te recomendamos abrir un Nuevo tema en lugar de responder al actual.
Respuesta




La zona horaria es GMT -6. Ahora son las 02:20.