comentario de Python
Funciones y métodos de Python
Michael Zippo
01.11.2021
Un comentario de Python es una lìnea de texto en un programa que no es ejecutado por el intérprete. Los comentarios se utilizan durante la depuraciòn para identificar problemas y explicar el còdigo. Los comentarios comienzan con un carácter de almohadilla (#).
Los comentarios indican notas o còdigo que no desea que Python ejecute. Por ejemplo, supongamos que está escribiendo un procedimiento complejo durante un perìodo de horas. Es posible que desee escribir algunos comentarios para realizar un seguimiento de lo que hace cada lìnea de còdigo para no perder la pista.
Escribir comentarios es √∫til por varias razones. Si está trabajando con un gran programa de Python, los comentarios pueden ayudarlo a realizar un seguimiento de lo que está sucediendo. Comentar también ayuda a los miembros del equipo a asegurarse de que todos comprendan el trabajo de los demás en un proyecto colaborativo.
Todos los desarrolladores eventualmente se encuentran con una situaciòn en la que deben incluir comentarios al escribir còdigo.
Pero, ¿còmo hacerlo? comenta sobre el còdigo en Python? Como cualquier otro lenguaje de programaciòn, Python admite comentarios. En esta guìa, vamos a hablar sobre còmo escribir comentarios en Python.
¿Qué es un comentario de Python?
Un comentario de Python es una lìnea de texto que aparece en un programa pero no es ejecutado por el programa. Puede declarar un comentario usando un hashtag (#). Los comentarios pueden aparecer en una nueva lìnea o al final de una lìnea de còdigo existente.
Los comentarios se utilizan para explicar còmo funciona el còdigo y con fines de prueba.
Aquì hay un ejemplo un comentario de una sola lìnea en Python:
El 81% de los participantes afirmaron que se sentìan más seguros sobre sus perspectivas laborales después de asistir a un bootcamp. Asigne a un bootcamp hoy.
El graduado promedio de bootcamp pasò menos de seis meses en la transiciòn de carrera, desde comenzar un bootcamp hasta encontrar su primer trabajo.
Puede ver el hash # marca denota nuestro comentario. Hemos separado el texto de nuestro comentario y el signo # con un espacio. Esto no es necesario, pero hace que cada comentario sea más fácil de leer.
El compilador ignora esta lìnea cuando ejecutamos nuestro còdigo. Los comentarios deben ser leìdos por humanos. No son para que los ejecute un programa.
Los comentarios deben agregarse al mismo nivel de sangrìa que el còdigo al que se refiere el comentario. Por ejemplo, digamos que está escribiendo sobre una lìnea de còdigo dentro de una instrucciòn if . Aplicará sangrìa a su comentario de la misma manera que lo hizo con su còdigo.
Ejemplo de comentarios de Python
Digamos que está escribiendo un bucle for y desea recordar còmo funciona. Puede que desee escribir un pocos comentarios. Cuando vuelva a mirar su còdigo más tarde, podrá leer sus notas.
En un Python for loop , es posible que tenga comentarios como este:
Nuestros comentarios nos ayudan a comprender el propòsito de nuestro còdigo y a realizar un seguimiento de lo que está sucediendo.
Usemos un ejemplo para ilustrar la estructura de sangrìa e de comentarios en Python. En el siguiente ejemplo, nuestro programa recorre dos matrices de Python y le da a cada estudiante un aprobado o reprobado para su prueba. Los aprobados y reprobados se determinan en funciòn de los estudiantes y rsquo; puntuaciòn numérica en su prueba:
Este programa toma una lista de estudiantes y sus calificaciones. Luego, nuestro programa recorre la lista de estudiantes. Verificamos si cada alumno ha aprobado o reprobado su prueba.
En el ejemplo anterior, puede ver que comentamos en el mismo nivel de sangrìa que la lìnea a la que nos referimos. Cuando hablamos de nuestra declaraciòn if de Python , por ejemplo, hemos sangrado nuestro comentario y nuestro còdigo.
Al escribir estos comentarios de una sola lìnea, nuestro programa es más legible tanto para el autor del còdigo. Nuestro programa también es más fácil para cualquier otra persona que pueda mire nuestro programa para leer.
Comentarios en lìnea de Python
Los comentarios en lìnea de Python se escriben en la misma lìnea que una declaraciòn, después de que se haya escrito el còdigo. Los comentarios en lìnea deben explicar el propòsito de una lìnea de còdigo o còmo funciona.
Aquì está la sintaxis de un comentario en lìnea:
Los comentarios en lìnea son √∫tiles si necesitas explicar partes complicadas del còdigo. También son √∫tiles si crees que puedes Olvìdese de còmo funciona una lìnea de còdigo especìfica en el futuro.
Los comentarios en lìnea también son √∫tiles si está trabajar en equipo y asegurarse de que todos entiendan una lìnea especìfica.
A diferencia de otros tipos de comentarios, solo use comentarios en lìnea ocasionalmente. Esto se debe a que demasiados comentarios en lìnea dificultan la lectura de un programa.
Comentarios de lìneas m√∫ltiples de Python
Los comentarios de lìneas m√∫ltiples de Python, o los comentarios de bloques de Python, explican el còdigo que es más complicado o cuyo propòsito no es inmediatamente obvio. Puede usar un comentario de bloque para explicar una funciòn √∫nica que usa una biblioteca externa, por ejemplo.
Los comentarios de bloque son comentarios de varias lìneas en Python y se aplican a parte o a todo el còdigo debajo de ellos. Los comentarios de bloque, como cualquier otro comentario, también están sangrados al mismo nivel que el còdigo del que se trata el comentario.
Ejemplo de comentario de varias lìneas
Aquì hay un ejemplo de una cadena de varias lìneas que explica una funciòn Python sort () :
"Career Karma entrò en mi vida cuando más lo necesitaba y rápidamente me ayudò a combinar con un bootcamp. ¬°Dos meses después de graduarme, encontré el trabajo de mis sue√±os que se alineaba con mis valores y metas en la vida! "
Venus, ingeniero de software en Rockbot
Nuestro comentario abarca varias lìneas y describe el propòsito del còdigo escrito debajo.
Si bien algunos desarrolladores pueden entender este còdigo, otros pueden estar confundidos acerca de còmo funciona o por qué se ha escrito. Usar un comentario en bloque es una excelente manera de explicar un procedimiento completo. Los comentarios de bloque son √∫tiles para explicar cualquier otro còdigo cuyo propòsito no sea inmediatamente obvio para un desarrollador.
¬°Asì es como comentas en Python! , puede hacer que sus programas sean más legibles para todos, incluido usted mismo.
Los comentarios bien escritos pueden ayudarlo a realizar un seguimiento de su còdigo sobre la marcha. Le permiten mantener un registro que puede ser referido volver a más tarde si tiene dificultades para entender su còdigo más adelante.
¿Está preparado para un desafìo? Escriba un comentario de bloque en la parte superior de uno de sus programas. Este comentario debe incluir:
Intente ejecutar su còdigo. Si su programa no se ejecuta debido al comentario, ha cometido un error. Si su programa se ejecuta normalmente, ¬°felicitaciones! Has escrito un comentario con éxito.
En este tutorial, hemos explorado còmo escribir comentarios, comentarios en lìnea y bloquear comentarios en Python. También discutimos còmo algunos desarrolladores escriben comentarios para realizar pruebas. ¬°Ahora puedes escribir comentarios como un experto en Python!
¿Buscas dominar el lenguaje de programaciòn Python? Para obtener asistencia sobre los mejores cursos, libros y recursos de aprendizaje de Python, consulte nuestra guìa Còmo aprender Python completa.
