Introducción a los comentarios en Python
Es esencial comprender el flujo de la programación, para qué se codifica y para qué. En general, para hacer esto, un programador usa comentarios para mostrar para qué es ese fragmento de código, para qué método se usa la codificación / la lógica detrás de él. Estos comentarios no van a influir en el código, pero proporcionarán un diseño para lo que se está haciendo. Escribir comentarios en el código ayuda a mejorar el código, ya que en la optimización un programador verifica lo que se necesita mejorar y si los comentarios muestran el método utilizado, será fácil optimizar el programa. Los comentarios en Python también permiten que los otros desarrolladores conozcan y entiendan el programa. Se recomienda utilizar una cantidad suficiente de comentarios para que el código no sea confuso cuando se mira hacia atrás.
Tipos de sintaxis en Python
En Python hay dos tipos de sintaxis que se utilizan para comentarios:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
En todos los lenguajes de programación, se ha definido una sintaxis para identificar qué es qué. Un programa se define con una serie de sintaxis para, por ejemplo, cerrar una línea en c usamos un punto y coma ';', para definir el inicio de una clase o ciclo usamos dos puntos ':' Como se puede ver, tenemos una sintaxis diferente que es la parte del código y la afecta. Debería haber alguna sintaxis que podría decir que debe cumplirse para dejar la parte comentada e ir al siguiente paso, ya que los comentarios no tienen nada que ver con la salida. Por lo tanto, es realmente muy necesario distinguir los comentarios del código real para que no se confunda con el programa real.
Crear comentarios en Python
Un programador debe agregar un comentario en su programa para hacerlo más comprensible. ¿Ahora dónde agregar comentarios? Es una elección individual, pero aquí hay algunos lugares comunes donde agregar comentarios hace que un programa sea más legible.
- Inicio del programa
- Al definir parámetros
- Definiendo una clase
- Métodos de definición
- Lógica de los métodos / funciones.
- Descripción sobre el procedimiento
- Para verificar la salida de un fragmento de código
Los siguientes puntos se explican a continuación:
1. Inicio del programa
Aquí un programador define cuál es el enunciado del problema y cuál es la necesidad del programa.
2. Al definir parámetros
Aquí un programador puede agregar comentarios para cada parámetro de lo que representa, cómo ayudará en el programa.
3. Definiendo una clase
Un programa puede contener nulas / una o más clases, por lo que es esencial definir el propósito de la clase al comienzo de los comentarios. A veces se recomienda agregar comentarios entre clases para definir el trabajo de cada línea en la clase.
4. Definición de métodos
Los métodos son funciones que crean relaciones entre parámetros y lógica para manipularlo. Se recomienda definir el trabajo del método en los comentarios.
5. La lógica de los métodos / funciones.
En general, un método puede tener una serie de lógicas adjuntas, comentar la descripción de cada lógica puede ayudar a comprender la lógica existente y, si es necesario, puede modificarse según el requisito.
6. Descripción del procedimiento
Para cada programa, un programador sigue un procedimiento paso a paso y la definición de los pasos del procedimiento / Arquitectura del código en los comentarios podría ayudar a mejorar su legibilidad.
7. Para verificar la salida de un código
En varios casos, un programador necesitaría hacer cambios en el programa existente. Si un programa tiene varias lógicas y para verificar si todas funcionan bien o no, debe tener salida de referencia / Salida esperada. Comentar los resultados de esa lógica justo después de la lógica podría ahorrar mucho tiempo.
Ejemplos de comentarios en Python
Los ejemplos se dan a continuación:
Los comentarios no tienen ningún efecto en la salida, pero hacen que un programa sea más legible. Aquí hay algunos ejemplos de comentarios en python.
1. Comentando una línea a la vez: Aquí estamos realizando operaciones de suma en dos variables.
# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Salida: 22
2. Comentario de varias líneas a la vez: a veces es necesario proporcionar una descripción de alguna lógica, para lo cual es necesario comentar varias líneas a la vez. Comentar una sola línea, una y otra vez, podría ser un trabajo agotador, por lo que usamos comillas triples para esto.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)
Salida: 22
3. Comentando una línea y varias líneas al mismo tiempo: en la mayoría de los casos, un programador usa ambos tipos de comentarios para hacer que el programa sea más legible.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Salida: 22
Aquí hemos visto algunos casos de comentarios, que se utilizan en un programa. En el caso del aprendizaje automático, existen diferentes tipos de modelos, que se utilizan para predecir la salida. Es necesario modelar parámetros, hiperparámetros y procedimientos utilizados en el algoritmo. Comentando diferentes enfoques para el modelo con diferentes parámetros puede ahorrar repetibilidad y puede ahorrar tiempo.
Conclusión - Comentarios en Python
Los comentarios en un programa son muy útiles para comprenderlos. En python, básicamente tenemos dos tipos de comentarios, ya sea para comentar una línea con sintaxis (#) o para comentar varias líneas, usamos comillas triples (“). Los comentarios no están ahí para influir en el código, sino solo para agregar una descripción de lo que se codifica allí y los comentarios no formarán parte de la salida.
Artículos recomendados
Esta es una guía de comentarios en Python. Aquí discutimos la Introducción, la creación de comentarios en Python ha tenido en cuenta, los ejemplos y la sintaxis, etc. También puede consultar nuestros otros artículos sugeridos para obtener más información.
- Intercambio en Python
- Comandos de Python
- Ingeniería inversa con Python
- Intercambio en C
- Variables en JavaScript
- Ingeniería inversa | Usos | Cuestiones éticas
- ¿Cómo funcionan los comentarios en PHP? El | Ejemplos