Parte 1 de 2:
Estilos
-
Utilice comentarios de una sola línea para comentarios breves. Si necesita dejar un comentario breve, puede utilizar el código de comentario de una sola línea. El comentario solo durará hasta el final de la línea o el final del bloque de código. Estos comentarios solo funcionan dentro de las etiquetas PHP y se leerán si se colocan en HTML.[1]
-
Utilice comentarios de varias líneas para comentarios más largos o pruebas de código. Los comentarios de varias líneas son útiles para escribir una explicación larga o para evitar que se procese un segmento de código. Consulte la sección “Uso” a continuación para obtener algunos consejos sobre el uso de comentarios de varias líneas.[2]
Parte 2 de 2:
Uso
-
Use comentarios para dejar notas sobre cómo funciona el código. No debería tener que hacer esto para cada línea de código, ya que el buen código debería ser bastante fácil de analizar por otros programadores. Es útil si el código está realizando funciones irregulares o no obvias.[3]
// Generate curl request $session = curl_init($request); // Tell curl to use HTTP POST curl_setopt ($session, CURLOPT_POST, true);
-
Deja comentarios para que recuerdes lo que estabas haciendo. Siempre que esté trabajando en sus propios proyectos, los comentarios pueden ayudarlo a recordar dónde lo dejó. Deje comentarios sobre el código que no funciona correctamente o que aún no ha terminado.
// Need to revisit the output for this before moving on echo "Hello World!";
-
Comente el código que desea compartir. Si planea colaborar con otros, o tiene la intención de hacer que su código sea de código abierto, los comentarios pueden ayudar a otros a descubrir cómo funciona su código y los mejores lugares para realizar mejoras.[4]
/* Is there a more effective way to accomplish this? */ Gender: value="female">Female value="male">Male
-
Utilice comentarios para evitar que se ejecuten bloques específicos de código. Esto es útil si está probando algo y necesita evitar que se ejecute cierto código. Todo lo que esté contenido en las etiquetas de comentarios se ignorará cuando se cargue la página.
-
Tenga cuidado al comentar grandes bloques de código. La función de comentario finalizará cada vez que se presione la primera etiqueta final, por lo que si ya hay un comentario de varias líneas dentro del código que comenta, el comentario solo durará hasta el final del comentario anidado original.
-
Utilice comentarios para crear pseudodocumentación. Puede utilizar algún formato de código creativo para crear documentación para su código directamente en el código. Esto puede resultar útil para proyectos de código abierto.
código comentarios comentario uso