2011-01-18 10 views
5

Estoy buscando algunos consejos generales sobre cómo mantener mi Javascript organizado y modular.Crear un sitio web pesado javascript modular y organizado

El último proyecto pesada Javascript he trabajado en la apariencia como [lo siguiente] [1] (formato http://jsfiddle.net/wdkZd/)

Como se puede ver i trato de espacio de nombres mis JavaScript y construir bastantes funciones separadas. Aun así, cuando necesito implementar funciones después, a veces me puedo perder en mi propio código. Y me da la idea de que puedo mejorar organizando mi código.

¿Alguna sugerencia general basada en lo que puede ver aquí?

Respuesta

4

Durante los últimos 2 años he estado trabajando en un proyecto con una base de código javascript bastante grande (10000+ líneas), que involucra a más de 30 desarrolladores activos de JavaScript.

Como tal, probablemente pueda imaginar que hemos tenido nuestra parte de miseria tratando de mantener el código en forma y todo tiene sentido y es fácil de mantener (es un entorno muy ágil, donde las especificaciones cambian semanalmente, si no más a menudo)

Algunas de las formas en que hemos tratado de abordar los problemas de la estructura son los siguientes:

  • namespacing es una necesidad.
  • construir su aplicación en capas, por ejemplo, tenemos el siguiente capas definidas en nuestro código: transporte, datos, BusinessLogic, control & ui
  • construir sus capas alrededor de los componentes/módulos selfcontained reutilizables comunes unittested, como: estado, la selección , plantillas, almacenamiento, eventos, etc.
  • usa patrones, lee los diferentes, entiende cuándo usarlos, y comienza a hacerlo, si no :)
  • mantén el estilo de codificación constante, no lo hagas t se desvía, a menos que sea absolutamente necesario, el código debe ser autoexplicativo, los comentarios son un mal que solo debería ser necesario en casos extremos
  • intente pensar en términos como: uso antes de la reutilización, simplicidad y facilidad de mantenimiento antes que elegancia; dése mantras y cúmplase a ellos
+0

¿Puede explicar "los comentarios son un mal que solo debería ser necesario en casos extremos"? un poco contra-intuitivo para mí. – ianace

+0

Un buen código debe ser explicativo para el lector (dado que el lector está familiarizado con el idioma): cada vez que necesite escribir comentarios en su código, debe detenerse y reflexionar sobre el tiempo en que podría haberlo escrito mejor. Dicho esto, los comentarios son una herramienta útil, pero si tienes que confiar en ello, entonces tienes un problema. –

+0

Jespersen, ¿este enfoque está limitado a los idiomas de alto nivel? ¿O lo generalizarías a todo el mundo de la programación? ¿Usarlo sería algo difícil de vivir? – ianace

1

Algunas prácticas que sigo para mantener mi Javascript organizada:

  1. Minify todas las bibliotecas en un solo archivo
  2. página
  3. carga JS específicos en los pies de página menos que sea requerido
  4. Combinar todos JS globales en un único archivo. {minify solo cuando en la etapa de producción}

y mirando a su JS, parece ser bastante organizado. Como está desarrollando un complemento, sería una buena opción tener la capacidad de seleccionar módulos al descargar su complemento. Algo similar a Jquery UI

Cuestiones relacionadas