PHP, HTML, JavaScript y escribiendo buenas prácticas

softwareengineering.stackexchange https://softwareengineering.stackexchange.com/questions/9584

Pregunta

Me di cuenta de que tengo que escribir una especificación de la convención sobre HTML, JavaScript y PHP codificando para mí y mi equipo.

En el desarrollo web, al igual que en C ++, definitivamente soy fanático de la sangría y los comentarios.

No obstante, a menudo en mi trabajo me encuentro con el código HTML+JavaScript+PHP que de repente plantea el dolor de cabeza.

Estoy tratando de hacer que mi código sea legible, pero lo que parece ser mejor para mí (para sangrar y comentar) parece no fascinar a mis compañeros de equipo, así que me preguntaba si hay una mejor o al menos una buena práctica al escribir "híbrido "Documentos como las páginas web de hoy, que día a día se vuelven cada vez más complejas.

Soy consciente del hecho de que probablemente esté en la naturaleza del código de las páginas web de hoy en día, estar un poco introducido, pero me pregunto si ya existe una buena convención sobre estos aspectos.

¿Fue útil?

Solución

Algunas reglas generales que sigo:

General

  • Las sangrías son 4 espacios.
  • Calentar nuevos niveles
  • Los comentarios son <~ 80 caracteres del nivel de sangría. Si estoy en dos niveles (8 espacios), eso significa que la parada del cursor será de alrededor de 88 caracteres.
  • Use comentarios de múltiples líneas. Prefiero el look, sin embargo, este es un subjetivo punto.
  • Comenta ahora más tarde cuando no tienes idea de lo que está pasando.
  • Aparatos ortopédicos de Allman. Es más limpio y es más legible. Subjetivo.

Javascript

  • Use una biblioteca. JQuery en particular es muy bueno. Elimina todos los dolores de cabeza del navegador cruzado.
  • Comprender que las identificaciones son para elementos particulares, las clases son para estilos. Las identificaciones no deben usarse más de una vez por página y tendrán ganchos particulares adjuntos a ellos. Use clases para cosas como la navegación.
  • Fuente de salida en métodos. Es tentador poner todo el código en el bind Llame, sin embargo, ponerlo en su propia función aumentará la flexibilidad de su código.
  • Use funciones en lugar de evals. Eso significa setTimeout(function(){ /* Do something */ }, 1000); en vez de setTimeout('doSomething', 1000);
  • Use variables locales con var.

Html

  • Marcado semántico. Use etiquetas apropiadas. No pongas <br />Está allí para agregar espacio, ajustar los márgenes y las reglas CSS.
  • Todas las etiquetas son minúscula.
  • Todas las etiquetas deberían Termine con una etiqueta de cierre o se cierre.
  • Haga uso de clases para el diseño que sea similar. Tener un par de clases predefinidas como hide, clear, error, etc.
  • Todo (scripts incluidos) debe entrar <head>. Preocuparse por optimizar (mover cosas) cuando presente un problema.
  • Hojas de estilo externos y fuente de JavaScript es un deber a menos que sea específica de la página.

Php

  • Los marcos son buenos, recomiendo Codeigniter.
  • Si no desea usar un marco, intente usar la última versión de PHP Possible. (Eso significa 5.3).
  • Usar includes a tu beneficio.
  • Inyecciones claras o utilizar declaraciones preparadas.

  • Realice si se verifica los valores de fallas de fallas preconcebidas.

    $logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}
  • Conozca la diferencia entre citas simples y dobles. Use citas individuales cuando sea posible.
  • No se hagan eco de HTML.

Otros consejos

Mantenga los 3 separados. El código menos mantenible con el que trato es siempre cuando hay un PHP que se hace eco de mucho HTML y JavaScript, probablemente con un SQL lanzado por si acaso.

Mantenerlos a todos como separados hará que el código sea mucho más fácil de mantener, y también hace que las cosas sean mucho más simplificadas si tiene personas que trabajan en diferentes partes de la aplicación, como el diseñador que solo necesita trabajar con el HTML/CSS.

Hay algo de lectura para inspiración:

  • Marco Zend - Estilo de codificación PHP : Lista de prácticas Cómo escribir código PHP mantenente (formato de archivo PHP, convenciones de nombres, estilo de codificación: matrices, cadena, clase, método por ejemplo).
  • Google - Guía de estilo de código : Lista de prácticas Cómo escribir el código JavaScript mantenimiento (Reglas: Constans, Semicolons, Función anidada ..., Estilo de codificación: Nompos, alcance, cadena, campos de visibilidad, etc.).

La forma más fácil de codificar una aplicación web de PHP es ciertamente combinar todo. Sin embargo, termina rápidamente con un desastre imperdible si hace las cosas de esa manera.

Aquí hay algunas buenas prácticas:

1) Pon tu JavaScript en elu003Chead> de un documento (o, mejor aún, en archivos separados a los que se hace referencia en el encabezado). Aprenda a vincular a los oyentes de eventos en un evento de documento. (Mejor aún, aprenda a usar un marco como jQuery; hará que su JavaScript sea mucho, mucho más bonito).

2) Busque patrones de diseño como MVC. Desea separar su lógica comercial, escrita en PHP, de su HTML tanto como sea posible. Idealmente, terminas usando un buen lenguaje de plantilla para armar tus páginas HTML; Como mínimo, el PHP en su HTML debe ser atenta, principalmente llamando a variables y recorriendo listas que se construyen en otros lugares.

3) Comentarios, sangría ... esas cosas son solo las mejores prácticas de programación básica. Tiendo a dejar que la longitud de mi línea supere los 80 caracteres cuando escribo HTML, solo porque el lenguaje es muy detallado, pero esa es la única práctica tradicional que debes dejar pasar por la deslizamiento, si el resto del equipo está siendo descuidado, Necesitan absorberlo y dar forma.

Aquí hay un par de cositas:

JavaScript: use var Al inicializar variables.

HTML: incluya scripts en la parte inferior del archivo para que se carguen por última vez.

PHP: divida los archivos. No ponga todas sus clases en un archivo, tal como no lo haría en el desarrollo normal de C ++. Comente tanto como sea posible y también escriba el propósito de sus funciones/clases.

Licenciado bajo: CC-BY-SA con atribución
scroll top