Agregar comentarios en PHP: 7 pasos (con imágenes)

Contenido

Pasos
- Parte 1 de 2: Estilos
- Parte 2 de 2: Uso
Consejos

Los comentarios dentro de un lenguaje de programación son ciertas notas que se pueden usar para aclarar el propósito y la intención de un bloque de código. Cuando usa PHP, tiene múltiples opciones para elegir que provienen de lenguajes de programación más antiguos y ampliamente utilizados con dos opciones cuando se trata de comentarios de una sola línea y también un formulario de comentario de varias líneas, derivado del estilo utilizado en el C lenguaje de programación. Puede usar comentarios para evitar que se ejecuten bloques de código, e incluso puede usarlos para generar documentación.

Pasos

Parte 1 de 2: Estilos

1. Use comentarios de una línea para comentarios breves. Si desea publicar un comentario breve, puede usar el código de una línea para eso. Este comentario no va más allá del final de la línea o el final del bloque de código. Este tipo de comentario solo funciona dentro de las etiquetas de PHP y se leerá si se coloca dentro del código HTML.

1. Use comentarios de varias líneas para comentarios más extensos o pruebas de código. Los comentarios de varias líneas son útiles para escribir una explicación más larga o para evitar que se ejecute un determinado segmento de código. leer la parte "Uso" a continuación para obtener algunos consejos sobre el uso de comentarios de varias líneas.

Parte 2 de 2: Uso

1. Use comentarios para dejar comentarios sobre cómo funciona el código. No hay necesidad de hacer esto para cada línea de código, ya que el código bien escrito es fácil de entender para otros programadores. Es útil si hay funciones inusuales o poco claras en el código.

// Generar solicitud curl $sesión = curl_init($solicitud); // Dile a curl que use HTTP POST curl_setopt ($session, CURLOPT_POST, true);

Deja un comentario para que no olvides lo que hiciste. Cuando trabaje en sus propios proyectos, los comentarios pueden ayudarlo a recordar dónde lo dejó. Comenta el código que no funciona o que aún no has completado.

// Tengo que ver esto antes de continuar echo "Hola Mundo!";

Comenta el código que quieres compartir. Si planea colaborar con otros, o desea que el código sea de código abierto, los comentarios pueden ayudar a otros a descubrir qué hacen sus funciones y dónde pueden mejorar.

/* ¿Hay una forma más efectiva de hacer esto?? */ Sexo:

Use comentarios para evitar que se ejecuten ciertos bloques de código. Esto es útil si desea probar algo y evitar que se ejecute cierto código. Todo lo que esté dentro de las etiquetas de comentarios se ignorará al cargar la página web.

2. Tenga cuidado al comentar grandes bloques de código. La función de comentario se detendrá cuando se señale la primera etiqueta final, por lo que si ya hay un comentario de varias líneas dentro del código que desea comentar, este comentario se detendrá al final del comentario anidado.

3. Use comentarios para crear pseudo-documentación. Puede usar algún formato creativo para crear documentación para su código directamente en el código. Esto puede ser útil para proyectos de código abierto.

Consejos

Los comentarios de HTML y los comentarios de PHP son diferentes, por lo que si utiliza secuencias de comandos (una combinación de HTML y PHP), tenga cuidado de no confundir los códigos de comentarios.
Por ejemplo, en el código a continuación, tiene comentarios HTML, pero el código PHP aún se ejecuta. Colocar comentarios HTML dentro de etiquetas PHP causará errores.