homefinance blog
El formato del código y los comentarios son una de esas cosas que solo nota una vez. Si se usa para mostrar y documentar el código correctamente, observe su existencia solo la primera vez que se enfrenta a un bloque de código que faltan. La mayoría de las personas que ejecutan o tienen un sitio web tarde o temprano están experimentando la base del código. Esto puede suceder al crear un nuevo elemento HTML, insertar algunos CSS personalizados o realizar cambios en una plantilla PHP WordPress. Para garantizar que no termine en un desastre, en esta publicación veremos las mejores prácticas para formatear el código y los comentarios. Descubrirá por qué son esenciales y también cómo usarlos correctamente.
Debido a que hay muchos lenguajes de programación y marcado con diferentes convenciones, nos limitaremos al diseño web más común, es decir, HTML, CSS, PHP y JavaScript. ¿Por qué debería formatear y documentar su código? Antes de ingresar las instrucciones, hablemos sobre la razón por la cual esto importa. El formato del código no es necesario para la funcionalidad primero, el código de formato y comentarios no es realmente necesario para que funcione una función. Los autos como los navegadores son perfectamente capaces de leerlo y ejecutarlo sin. Por lo tanto, puede usar técnicas como minería para acelerar su sitio web de WordPress.
A una computadora no le importa si el código se ve hermoso siempre que sea correcto y no produzca errores. Sin embargo, hace que la marca sea más fácil de leer por el hombre, sin embargo, ¿sabes a quién le importa el formateo del código y los comentarios? Gente. Personas como usted y yo, que tienen que leer, comprender y modificar el código de vez en cuando. En estos casos, es mucho más fácil si tiene un formato adecuado y/o comentarios que hacen que el código sea más fácil de entender. El no uso de la formación en el código es equivalente a no usar formateo de escritura. Ni siquiera leería esta publicación si elimino todos los párrafos y títulos, sin importar cuán bueno sea el contenido. Por esta razón, a la gente se les ocurrió convenciones para asegurarse de que el código sea tan fácil de entender. Esto ayuda a evitar errores, solucionar problemas y hacer que el mantenimiento de otra persona funcione mucho más fácilmente. Partes esenciales del formato del código, sin embargo, es importante tener en cuenta que no hay una forma final de diseñar el código. Por ejemplo, el formato diferente puede tener sentido para diferentes marcas. La aplicación de formatos CSS a HTML o viceversa no necesariamente facilitaría la comprensión. Por lo tanto, hay diferentes convenciones dependiendo del idioma que use. Sin embargo, todos giran principalmente alrededor de lo siguiente:
sangrar
espacio en blanco
Convenciones y nombres de escritura cálculos
Estilo y ortografía de funciones, variables y más
Uso y estilo de comentarios
Dentro de estas convenciones más amplias, los desarrolladores a menudo usan su propio estilo de acuerdo con sus preferencias. Sin embargo, hay algunos elementos de formatear el código y los comentarios que son bastante universales y, a continuación, los analizaremos. Cómo formar el código: nociones básicas de aquí, le daremos alguna orientación sobre cómo formatear el código, para que sea más fácil trabajar con él. Apariencia: la sangría, las interrupciones de línea, el formato del uso de una apariencia adecuada ayuda a identificar las partes del código que pertenecen juntas, que dependen mutuamente y de muchos más. Las herramientas básicas para esto son la sangría, las interrupciones de línea y otras opciones de formato. Aquí le mostramos cómo usarlos en diferentes lenguajes de programación.
Puede hacerlo con una pestaña o con más espacios. Hay discusiones sobre las cuales la forma correcta de hacer esto (¡sorpresa!), Pero puede ir con lo que funciona para usted. La sangría correcta también coloca los soportes de cierre de los contenedores, como los elementos DIV, en el mismo nivel vertical, por lo que es fácil ver si los ha cerrado o no. Agregar comentarios (más sobre esto a continuación) deja esto aún más claro.
Esto a veces se amplifica por los giros de transporte que introducen aún más espacio alrededor de los elementos.CSS Aquí hay algunos códigos CSS CSS bien formulados: .Search-Submit {Border-Radius: 0 2px 2px 0;Abajo: 0;Desbordamiento: oculto;Relleno: 0;Posición: Absoluto;Derecha: 0;Arriba: 0;Ancho: 42px;} ¿Por qué se ven bien?Muchas razones: hay espacio entre operadores, aparatos ortopédicos y propiedades, las reglas han sido sangradas, son alfabéticas y cada una tiene su propia línea y todo está cerrado en una línea adicional.Una forma adicional de hacer que CSS sea más fácil de entender es el uso de la abreviatura.Compare estos dos fragmentos:
.footer {margin-bottom: 10px; Margen-izquierda: 5px; Margen-derecha: 5px; margen-top: 10px; } .footer {margen: 10px 5px; Hacen lo mismo, pero uno es mucho más corto. Finalmente, cuando use consultas de medios, asegúrese de ajustarlas el uno en el otro y sangrarlas correctamente. @Media Screen y (Min-Width: 56.875em) {.Site-Header {Padding-Raggs: 4.5455%; ROLDE-LEFUNTO: 4.5455%; }} PHP Reglas similares se aplica al código PHP. Aquí hay un ejemplo de las veinte diecinueve funciones.php: function twentynineteen_widgets_init () {registre_sidebar (‘name’ => __ (‘pie’, ‘twentynineteen),’ id ‘=> lateral-1’, ‘descripción => __ (( ‘Agregue widgets aquí para aparecer en su foloter.’, ‘twentynineteen’), ‘before_widget’ => ‘
‘, ‘after_widget’ => ‘
‘, ‘,’ antes_itle ‘=>’
‘,’ after_title => ‘
,)); } add_action (‘widgets_init’, ‘twentynineteen_widgets_init’); ¿Notas las líneas y las salidas de línea aquí? También tenga cuidado de que todos => se colocaran a la misma altura. Esto aumenta aún más legibilidad.
JavaScript Finalmente, aquí hay un ejemplo de JavaScript: const HeadingColuuri = Memo (function ({textColorValue, setTextColor,}) {return ();}); Puedes ver los mismos principios en el trabajo. Convenciones de nombres y escritura con letras mayúsculas Otra parte del código legible es la optimización de su contenido. Aquí, es importante que lo que escriba para tener sentido y las personas puedan entender lo que hace cada elemento, funcione o variable. De esta manera, verán desde una mirada y dónde hacer cambios. Aquí le mostramos cómo hacer eso. Sea descriptivo, lo primero es que el nombre que usa no es aleatorio, pero en realidad explica lo que hace un código. No registrado Cualquiera que examine su trabajo debería poder comprender inmediatamente la función de cada elemento. Créeme, obtendrás tu pie en el futuro si no te adheres a él. No hay nada peor que enojarse en tu yo pasado porque eres flojo.
Averigüe sobre las convenciones como se mencionó anteriormente, los diversos idiomas de programación y marcado tienen diferentes convenciones y es lógico respetarlas.
Cuando se trata de nombre, en HTML y CST, todo suele ser en minúsculas. Estos incluyen nombres de elementos, atributos, valores, selectores, propiedades, así como clases e ID de HTML. Sin embargo, como aprendí anteriormente, este no es el caso para cada lenguaje de programación. En PHP y JavaScript, también verá cosas en CamelCase, Under_Scores o con Hyphens Under_Scores. ¿Cual es correcta? Bueno, todo funciona, por lo que no hay una solución incorrecta (excepto JavaScript, que puede ocurrir como disminuye, así que no las use). Como resultado, lo más importante aquí es decidir sobre uno y quedarse con él. Aparte de eso, es lógico ver la convención de la plataforma en la que trabaja. Por ejemplo, WordPress fomenta el uso de personajes subrayadores en PHP y Camelcase en JavaScript. Entonces, si trabaja con la plataforma de WordPress, es una buena idea respetar estas convenciones, especialmente porque muchas variables existentes, etc. Ya estoy en ese formato. Los comentarios codifican las mejores prácticas con lo anterior, hay altas posibilidades de que cada vez que otro desarrollador mira su trabajo, puedan entender lo que está sucediendo con bastante rapidez. En este caso, su código es lo que la gente llama “autocdocumentación”. Sin embargo, este es solo el primer paso. En muchos casos, necesita documentación real en forma de comentarios. Aprenda a incluir comentarios que casi todas las programas o marcadores le permiten ingresar comentarios. Esto significa que puede marcar el texto de una manera para que los navegadores no lo ejecuten. Aquí le mostramos cómo hacer esto en diferentes idiomas:
Html-in html .Si pasa en varias ocasiones, a menudo coloque los soportes de apertura y cierre en sus propias líneas y coloque los comentarios sangrados entre ellos. CSS – Cualquier cosa entre / * y * / es un comentario.Pueden pasar varias líneas.
PHP-PHP conoce dos tipos de comentarios: una sola línea (marcada con // o #) y multi-linie (creado con / * … * /, como CSS).
JavaScript: cree un comentario en una sola línea con //.Funciona múltiples líneas como CSS/PHP.
Un buen ejemplo para comentar el código es el jefe del tema de WordPress Child. /* Nombre del tema: Veinte diecisiete Tema Uri: https://wordpress.org/themes/twisentysevennteen/ Autor: The WordPress Team Autor: https://wordpress.org/ Descripción: Veinte Severente Su sitio a Video e Inmersive Video e Inmersive Imágenes destacadas. Con un enfoque en los sitios comerciales, presenta múltiples secciones en la página principal, así como widgets, navegación y menús sociales, un logotipo y más. Personalice su cuadrícula asimética con un esquema de color personalizado y muestre su contenido multimedia con formatos de publicación. Nuestro tema predeterminado para 2017 funciona muy bien en muchos idiomas, para cualquier habilidad y en cualquier dispositivo. Versión: 2.2 Licencias: GNU General Public License V2 o licencias posteriores: http://www.gnu.org/licenses/gpl-2.0.html Dominio de texto: Veinteseventeen etiquetas: una columna, dos columnas, didebar derecha, flexible -Madreer, listo para accesibilidad, Customors, Custom-Header, Custom-Menu, Custom-Logo, editor, estilo editor, IMAGE, Widgets, Post-Formats, RTL-Lenguage-Support, Sticky-Post, Tema -OPTIONES, COMMENTOS ANTERIORES, Lista de traducción Este tema, como WordPress, tiene licencia bajo el LPP. Úselo para hacer algo genial, divertirse y compartir lo que usted ‘
He aprendido con otros.*/ Use los comentarios para aclarar su marca aún, ¿qué debe usar?Los comentarios están destinados a ayudar a cualquiera a comprender el código con el que trabaja.Esto incluye su yo futuro (porque es posible que no recuerdes lo que hiciste antes) o alguien que te quita.Por esta razón, es muy lógico dejar información sobre lo que está sucediendo.Describa lo que hace una determinada función o bloque de bloque, que pertenece a una pieza de CSS, etc.//* Agregar nuevos tamaños de imagen ADD_IMAGE_SIZE (‘Blog’, 700, 300, True);Muchos desarrolladores también los usan para crear tablas de contenido para sus hojas de estilo./*——————————————— ———— >>>
Tabla de contenido: ———————————————- ————— 1.0 Normalice 2.0 Accesibilidad 3.0 Alineaciones 4.0 Clearings 5.0 Typografía 6.0 Formularios 7.0 Formación de 8.0 Listas 9.0 Tablas 10.0 Enlaces 11.0 Imagen destacado Hover 12.0 Navegación 13.0 Diseño 13.1 Encabezado 13.2 Página de primera plana 13.3 Regular Contenido 13.4 Publicaciones 13.5 Páginas 13.6 Purero 14.0 Comentarios 15.0 Widgets 16.0 Medios 16.1 Galerías 17.0 Customizer 18.0 SVGS Fallbacks 19.0 Consultas de medios 20.0 Impresión ————————- ——— —————————————-* / Para ser lo más útil posible, y aquí, asegúrese de ser descriptivo y claro en el contenido. Además, decida una sola forma de incluir comentarios y no se convierta. Herramientas para formatear el código Recuerde todas las reglas sobre el formato correcto puede ser difícil. Solo cubrimos los elementos básicos y obtenemos un artículo completo. Por lo tanto, para reducir el esfuerzo de usted, puede usar una serie de herramientas para que el formato sea más automático y sin esfuerzo. Herramientas en línea Aquí hay una serie de herramientas en las que puede pegar su código y escupirán una versión más hermosa: HTML Formatant
Formator de php
CSS formatante y de belleza
Belleza javascript
Complementos para el editor de códigos Además de esto, también hay complementos para editores de código que pueden hacer tales cosas automáticamente.
Belleza atom
HTML-CSS-JS Prettify para texto sublime
Prettier.io (funciona con Atom, Espresso, Texto Sublime, Webstorm y más)
Una búsqueda rápida de Google debería darle opciones para el editor deseado. Los editores de código también colorearán los diferentes elementos, aumentando aún más la legibilidad. Ya puede ver esto en funcionamiento en los ejemplos de código en esta publicación. Guías de estilo Eventualmente, si va especialmente en la ruta manual, puede encontrar una serie de guías de estilo para inspirarlo. Google Style
Guía de estilo de codificación de Mozilla
Formatear el código formatear brevemente el código y los comentarios son herramientas útiles para facilitar la marca, mantener y solucionar problemas. Arriba, ha aprendido formas básicas de usarlas para mejorar su flujo de trabajo. Vale la pena repetir que ninguno de los anteriores se establece en piedra. Si bien hay convenciones generales para que el código se vea bien, hay diferencias entre idiomas, desarrolladores, etc. Lo más importante es ser consistente. Una vez que haya establecido un estilo de formato, asegúrese de no desviarse de él, especialmente dentro del mismo archivo o proyecto. De lo contrario, cancelará piezas para las cuales el formato del código existe principalmente. Si trabaja con un equipo, crear una guía de estilo puede ayudarlo a mantener las cosas consistentes. ¿Cuáles son sus herramientas favoritas para el formato de código y los comentarios de código? ¿Algo para agregar a lo anterior? Háganos saber en la sección de comentarios a continuación.
