Cómo hacer comentarios en PHP

Autor: Sara Rhodes
Fecha De Creación: 16 Febrero 2021
Fecha De Actualización: 1 Mes De Julio 2024
Anonim
Meet Nova - A modern new code editor from Panic
Video: Meet Nova - A modern new code editor from Panic

Contenido

Un comentario es un tipo de nota que se puede utilizar para explicar el propósito y el significado de un fragmento de código. Trabajando en PHP, tendrá varias opciones para escribir comentarios que provienen de los viejos lenguajes de programación conocidos: ingresando comentarios en C de una o varias líneas. Puede utilizar comentarios para evitar que un fragmento de código funcione o simplemente para mantener registros.

Pasos

Parte 1 de 2: Estilos

  1. 1 Comentarios de una sola línea para publicaciones cortas. Si necesita dejar un comentario breve, use el código de comentario de una línea. El comentario solo se extenderá al final de una línea o al final de un bloque de código. Dichos comentarios solo funcionan dentro de las etiquetas PHP y solo se leerán si se colocan en HTML.

    ? php // Esta es la forma estándar (C ++) de crear un comentario de una sola línea # ¿También puede usar este estilo Unix para crear un comentario de una sola línea?> var13 ->

  2. 2 Utilice comentarios de varias líneas para escribir comentarios largos o código de prueba. Los comentarios de varias líneas son muy útiles para escribir explicaciones largas y para evitar que se procese un segmento de código. Lea la sección Uso para obtener algunos consejos sobre el uso de comentarios de varias líneas.

    ? php / * Aquí se explica cómo formatear un comentario de varias líneas. Todo el texto hasta el final de la etiqueta se incluirá en el comentario * / / * A algunas personas les gusta incluir * al principio de cada línea * viñetas adicionales. Esto mejorará la * legibilidad de comentarios grandes, aunque no es obligatorio. * /?> var13 ->

Parte 2 de 2: Uso

  1. 1 Utilice comentarios para dejar notas sobre el estado del código. No tiene que hacer esto para cada línea de código, ya que otros programadores pueden descubrir fácilmente un código bien escrito. Los comentarios son útiles cuando su código está realizando funciones no estándar o no obvias.

    // Crea una solicitud curl $ session = curl_init ($ request); // Dile a curl que use HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 Deje comentarios para no olvidar lo que hizo con el código. Cuando trabaje en un proyecto, los comentarios evitarán que olvide dónde lo dejó. Deje comentarios para el código que no funciona correctamente o que aún no ha terminado.

    // Antes de pasar al siguiente paso, verifique dos veces la salida de este programa echo "¡Hola mundo!";

  3. 3 Deja un comentario para el código que planeas compartir. Si planea colaborar con otros programadores o va a hacer que su código esté disponible públicamente, los comentarios ayudarán a otros a comprender cómo funciona su código y qué se debe corregir.

    / * ¿Hay una mejor manera de lograr esto? * / Género: input type = "radio" name = "gender"? Php if (isset ($ gender) && $ gender == "female") echo "comprobado" ;?> value = "female"> Female input type = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "comprobado";?> value = "male "> Hombre

  4. 4 Deje comentarios para deshacer bloques de código específicos. Esto es muy útil cuando está probando su código y desea detener la ejecución de una parte. Todo lo que esté incluido en la marca de comentario se ignorará cuando se inicie la página.

    ? php echo "/ * ¡Hola * / Mundo!"; / * Cuando se ejecuta el código anterior, la palabra "Hola" no se reflejará * /?> Var13 ->

  5. 5 Tenga cuidado al comentar grandes bloques de código. La función de comentarios terminará cuando la primera marca de finalización esté activa, por lo que si hay un comentario de varias líneas dentro del código que ya ha comentado, solo durará hasta el comienzo del comentario original.

    ? php / * echo "¡Hola mundo!"; / * Este comentario arruinará todo * / * /?> Var13 ->

    ? php / * echo "¡Hola mundo!"; // Este comentario estará bien * /?> Var13 ->

  6. 6 Utilice comentarios para crear pseudograbaciones. Puede utilizar algunos formatos de código creativo para crear una entrada de código dentro de él. Esto es bastante útil para proyectos de código abierto.

    ? php // ============= // ENCABEZADO // ============== // ------------ - // Subtítulo // ------------- / * Nombre de la sección * / # Las entradas se pueden escribir aquí # La segunda parte se puede escribir aquí / * * Use esto para explicar * ¿por qué necesitarías unas pocas líneas * o incluso algunos puntos de explicación * /?> var13 ->

Consejos

  • Los comentarios HTML y PHP son diferentes entre sí, por lo que cuando trabaje con scripts (una combinación de HTML y PHP), asegúrese de utilizar la sintaxis correcta.
  • Por ejemplo, el siguiente código contiene un comentario HTML, pero aún ejecuta el código PHP. Si coloca un comentario HTML dentro de una etiqueta PHP, resultará en un error.
    • ! - div id = "ejemplo">? php echo ’hola’; ?> var13 -> / div> ->