A煤n no tienes acceso a esta clase

Crea una cuenta y contin煤a viendo este curso

Especificaciones del c贸digo

17/31
Recursos

Aportes 198

Preguntas 17

Ordenar por:

驴Quieres ver m谩s aportes, preguntas y respuestas de la comunidad? Crea una cuenta o inicia sesi贸n.

El docstring o la documentaci贸n est谩 dividido en tres partes importantes que son las siguientes:

  • Primero se da una descripci贸n clara y concisa de la funci贸n y su funcionamiento

  • En medio se agrega la descripci贸n de los diferentes par谩metros, su tipo, su nombre y que es lo que se espera de esos par谩metros

  • Por ultimo se agrega que es lo que devuelve nuestra funci贸n

Les comparto una publicaci贸n excelente sobre buenas practicas con Python.
++Thomas Cokelaer - Ejemplo sobre c贸mo documentar sus cadenas de documentos en Python
++
https://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html

Les dejo algunas buenas pr谩cticas que encontr茅

  1. Recordar que en Python se maneja la indentaci贸n para delimitar bloques de instrucciones.
  2. Escribir los programas los m谩s simple posible.
  3. Comentar los programas, explicando el prop贸sito, funcionamiento completo y el resultado
    esperado.
  4. Al inicio de cada funci贸n, agregar brevemente un comentario que explique el comportamiento
    general de la funci贸n.
  5. Definir el nombre de funciones, variables y constantes que mejor representen el contenido que
    almacenar谩n.
  6. No usar variables cuyo nombre carezca de significado descriptivo. Con un c贸digo legible y
    nombres significativos, el c贸digo se va auto documentado.
  7. Declarar variables en l铆neas separadas, posibilitando agregar una descripci贸n de cada variable
    mediante comentarios.
  8. Definir el nombre de funciones, m贸dulos y clases que mejor representen las acciones que
    realizan.
  9. Definir el tama帽o de las sangr铆as para que sean regulares (consistentes) y no var铆en a lo largo
    del c贸digo, es decir, si el primer bloque ocupa como indentaci贸n una tabulaci贸n, el resto de
    bloques deben ser indentados con una tabulaci贸n adicional por cada nivel, con eso se facilita la
    lectura en cualquier editor de c贸digo.
    Ser consistente al momento de utilizar un est谩ndar para nombres largos, por ejemplo para una
    variable que almacena cantidad de alumnos 'contador_alumnos鈥
    Comentar cuando sea justo y necesario, usar los comentarios dentro de las funciones para
    describir las variables (s贸lo cuando su utilidad sea potencialmente dudosa) y cuando existan
    bloques de c贸digo dif铆ciles de entender a primera vista; el exceso de comentarios vuelve ilegible
    el c贸digo.
  10. Definir variables locales al inicio de la implementaci贸n de cada funci贸n, como un bloque de
    c贸digo bien separado del bloque que contenga las instrucciones ejecutables, 茅sta separaci贸n
    puede consistir en una l铆nea en blanco, o bien un comentario que denote la utilidad de cada
    bloque.
  11. Evitar la incorporaci贸n de m谩s de una instrucci贸n por l铆nea. Esto reduce notoriamente la
    legibilidad del c贸digo, ya que el programador habitualmente est谩 acostumbrado a leer una
    instrucci贸n por l铆nea.
    Realizar la indentaci贸n necesaria, si una instrucci贸n abarca m谩s de una l铆nea.

Documentacion:

  1. La primera linea debe ser un resumen, importante que quepa en una sola linea y este separada del resto de docstrings por un espacion en blanco.

  2. El resto de la cadena de documentaci贸n debe describir el comportamiento de la funci贸n.

  3. Se recomienda dejar una l铆nea en blanco antes de las triples comillas que cierran la cadena de documentaci贸n.

Fuente: http://edupython.blogspot.com/2013/12/documentando-programas-en-python.html

Y para saber m谩s sobre la funci贸n 鈥淗elp鈥, simplemente escribimos: help(help).
Resultado:

Especificaciones del codigo:

Tienen 3 partes fundamentales

  1. Que hace la funcion
  2. Que significan los parametros: Cual es el nombre del parametro y Cual es el tipo del parametro
  3. Que regresa esta funcion
def suma(a, b):
	"""Suma dos valores a y b.

	param int a cualquier entero
	param int b cualquier entero
	returns la sumatoria de a y b
	"""

	total = a + b
	return total

Comparto un enlace donde se complementas algunas practicas adicionales para el lenguaje pyhton

http://research.iac.es/sieinvens//python-course/source/estilo.html

Me permito dejarles este link para profundizar m谩s en los temas
https://www.w3schools.com/python/default.asp

En Html se usa <!-- COMENTARIO -->

Un docstring es la descripci贸n de la interfaz de una funci贸n. La interfaz se compone de:

  • Qu茅 hace la funci贸n.
  • Sus par谩metros con su tipo y que se espera en ellos.
  • Qu茅 retorna la funci贸n (si es que retorna algo)

馃槂

驴Cu谩les son las buenas pr谩cticas para escribir Documentaci贸n dentro de Python?

Casi tan importante como la escritura de c贸digo, es su correcta documentaci贸n, una parte fundamental de cualquier programa que a menudo se infravalora o simplemente se ignora. Aparte de los comentarios entre el c贸digo explicando c贸mo funciona, el elemento b谩sico de documentaci贸n de Python es el Docstring o cadena de documentaci贸n. Simplemente es una cadena de texto con triple comillas que se coloca justo despu茅s de la definici贸n de funci贸n o clase que sirve de documentaci贸n a ese elemento.

Adem谩s de esta documentaci贸n b谩sica, lo correcto es detallar mejor en el Docstring qu茅 hace y c贸mo se usa la funci贸n o clase y los par谩metros que necesita. Se recomienda usar el estilo de documentaci贸n del software de documentaci贸n sphinx, que emplea reStructuredText como lenguaje de marcado.

Ejemplo de una funci贸n bien documentada:



En este ejemplo de la funci贸n power() de numpy no solo se explica qu茅 hace la funci贸n, sino que indica los par谩metros de entrada y salida e incluso da algunos ejemplos de uso.

Con 鈥#鈥 tambien se puede hacer comentarios en el programa

Javadoc /* COMENTARIOS */

En C# se documenta de la siguiente manera

///<summary>
///Lee la configuraci贸n de la aplicaci贸n desde el disco.
///</summary>
///<return>
///Devuelve true si la configuraci贸n fue leida. Si hubo alg煤n error se devuelve false.
///</return>
///<param name="archivo">
///Ruta del archivo en disco a leer.
///</param>

En Python para el tema de comentario sugieren no m谩ximo de 72 caracteres.

Consulta, que diferente hay en documentar con 鈥溾" y #?

Lo mejor que pueden hacer es aprender a hacer la documentaci贸n desde que comienzan a aprender programaci贸n. si no, luego se acostumbran a nunca hacerlo y les terminar谩 costando m谩s trabajo algo que a final de cuentan tienen que aprender s铆 o s铆.

En la uni aprendo Java y la manera de documentar dentro del c贸digo es mediante el uso de

/** Descripci贸n del m茅todo
*@params
@return
*
*

As铆, se puede especificar por ejemplo que hace un m茅todo, que par谩metros recibe, qu茅 retorna y si es que lanza alguna excepci贸n. Luego mediante javadoc, una utilidad de Oracle, se genera la documentaci贸n contenida en un HTML y es ah铆 donde uno puede ver mediante links como usar ese m茅todo.
En Python las buenas practicas indicadas por PEP8 indican que un comentario inicializado con # no deber铆a tener mas de 72 caracteres. Tambi茅n resulta interesante agregar los pasos a seguir para resolver un problema, agregar una descripci贸n con docstrings o simplemente una linea que explique que hace el c贸digo.

Recuerden que tambi茅n podemos utilizar el # para hacer comentarios de una l铆nea y el 鈥溾" para hacer comentarios de varias l铆neas.
Para la documentaci贸n es necesario ser:
Conciso y preciso
Explicar los par谩metros
Lo que regresa la funci贸n

En javascript utilizamos jsdocs, bueno por lo menos intentamos jajajaja y es muy util con vs code, porque al hacer hover te aparece que hace la funci贸n, en especial con proyectos grandes es muy 煤til porqu茅 existen muchas capas de abstracci贸n para realizar muchas cosas relacionadas ya propiamente con la l贸gica de negocio de un proyecto

_RESUMEN: _

Python Docstring best practices 馃槂

Un Docstring puede ser de una linea:

Se usa para un resumen corto, conciso y claro. No puede completar m谩s de una linea y siempre debe terminar en un punto(s铆mbolo de puntuaci贸n).

Tambi茅n podemos usar Docstring se varias lineas.

Los Docstring de varias lineas consisten en un Docstring de una l铆nea (el resumen), seguido de una l铆nea en blanco, seguido de una descripci贸n m谩s elaborada.

**Tanto para Docstrings mono-linea o multi-linea: **

  1. Debe aparecer siempre en la primera secci贸n del m茅todo/clase/etc鈥
  2. Siempre Comillas triples (esto facilita su ampliaci贸n en el futuro).
  3. Siempre dejar una l铆nea en blanco despu茅s de cerrar el Docstring.
  4. para una funci贸n o m茅todo debe resumir su comportamiento y documentar sus argumentos, valores de retorno, excepciones generadas, etc.

hay m谩s especificaciones para m贸dulos, clases y subclases.

Todo esto y m谩s lo puedes ver a detalle en la convenci贸n oficial de Python
aqu铆

Nota: _Si violas estas convenciones, lo peor que obtendr谩s son miradas feas de tus compa帽eros. Pero algunos softwares (como el sistema de procesamiento de docstring Docutils) conocer谩n las convenciones, por lo que seguirlas le brindar谩 los mejores resultados. _

Si hay alguna **buena practica general **que me saltado d茅jala en los comentarios please.

Les comparto un link a una de las fuentes mas importantes de python en temas de estilo y buenas practicas en el cual podran encontrar recomendaciones para sus Documentation Strings entre muchas otras cosas
https://www.python.org/dev/peps/pep-0008/#documentation-strings

Una buena pr谩ctica en documentaci贸n de c贸digo es incluir los docstrings para las funciones, clases y m贸dulos, esto facilita la lectura posterior del c贸digo (es mejor leerla en la funci贸n, que en un README.md), y facilita la interacci贸n y modificaci贸n del c贸digo por parte de otros desarrolladores, sean del equipo o no.

Como apunte personal, llevo poco m谩s de 11 a帽os trabajando en infraestructura IT (Ciberseguridad, Servidores, Redes, etc.), y siempre se ha manejado la recomendaci贸n, por parte de los gerentes de proyecto, y la he implementado cuando lo he sido, de generar documentaci贸n completa y concisa de lo que se despleg贸; esto debido a que puede pasar un largo tiempo antes de que se le vuelva a 鈥渕eter mano鈥 a lo que se instal贸, y sea complicado despu茅s hacerlo; o en su defecto, no se realice de nuevo dicha administraci贸n nunca m谩s, y le sea dificil, si no es que imposible, a otra persona modifiarlo.

hay alguna razon concreta por lo cual no se usa camel case en python o solo por que si?

Ejemplo de documentaci贸n en Typescript

Creo que documentar es la mejor practica a la hora de trabajar en equipo 馃槃

ahhh vea pues de all铆 es que se crean las descripciones de help.!!

las comillas simples triples 鈥 鈥 'tambien sirven para comentar nuestro c贸digo.

Seg煤n lo que yo he aprendido en todo este tiempo, los comentarios en las funciones deberia ser un ultimo recurso y lo principal es tener un buen nombre de funcion y buenos nombres de las variables que a simple vista nos diga que hace la funcion.

Primera clase que no me estalla la cabeza jaja

" Aparte de los comentarios entre el c贸digo explicando c贸mo funciona, el elemento b谩sico de documentaci贸n de Python es el Docstring o cadena de documentaci贸n, que ya hemos visto. Simplemente es una cadena de texto con triple comillas que se coloca justo despu茅s de la definici贸n de funci贸n o clase (ver programaci贸n orientada objetos, m谩s adelante) que sirve de documentaci贸n a ese elemento".

me vol贸 la cabeza, es fundamental

No sab铆a que se pod铆a hacer desde la terminal!

Muy bueno

Es de much铆sima ayuda!
Por m谩s simple que sea mi c贸digo, voy a implementarlo siempre

En mi instituto el desarrollo web se hace con php y seg煤n lo que he investigado se realiza de la siguiente manera

<php
public function isLoggedIn();
  /**
 * Devuelve la informaci贸n del usuario sobre la cuenta
 *
 * This method is used to retrieve the account corresponding
 * to a given login. <b>Note:</b> it is not required that
 * the user be currently logged in.
 *
 * @access public
 * @param string $user user name of the account
 * @return Account
 */
  public function getAccount($user = '');
}
?>

Entendido

Que genial!! cada vez me gusta mas python!

Una excelente practica, a aplicarla en todos nuestros programas de ahora en adelante.

Por que n camelcase?

Una duda, porque no existe un estandar en la forma de crear la forma de comentar el c贸digo en los lenguajes.

Hola, dejo un articulo para hacerlo en JAVA
https://www.tutorialspoint.com/java/java_documentation.htm

Les comparto la gu铆a de estilos de Python. B谩sicamente es que hacer y que no cuando uses este lenguaje, espero le spueda ser de ayuda.

https://google.github.io/styleguide/pyguide.html

Excelente buena practica. a aprender a sintetizar la info para poder plasmarla.

Jeje, desde ahora pondr茅 especificaciones a mi c贸digo

Hacer eso ahorra mucho tiempo y dinero en el futuro. As铆 como un adecuado nombre de variables.

y yo que pensaba que con el # en cada l铆nea hac铆a lo mismo =O

Docstrings: Decimos que hace la funci贸n, describimos los par谩metros con sus tipos de datos, y indicamos que retornara la funci贸n.

Usando el m茅todo help() podemos obtener la informaci贸n de la funci贸n

A la documentaci贸n que ponemos all铆 le llamamos docstring y est谩 contenida por triple colons o triple comillas.

Despu茅s de terminar nuestro resumen, dejamos un espacio en blanco y al mismo nivel de identaci贸n cerramos las triples comillas.

Python:
La documentaci贸n de las funciones de Python se realiza mediante cadenas de documentaci贸n (鈥淒ocstring鈥). Una cadenas que se incluyen dentro de c贸digo para que los usuarios puedan consultarlas mediante la funci贸n nativa de Python help(). La cual imprimir谩 la cadena de documentaci贸n del objeto solictado.

Las cadenas de documentaci贸n se tienen que incluir inmediatamente despu茅s de la l铆nea en la que define el objeto. Para lo que se debe utilizar siempre cadenas de texto con comillas dobles triple, incluso cuando la documentaci贸n solamente conste de una l铆nea. Es importante que ninguna de las l铆neas de la documentaci贸n supere los 72 caracteres para que se pueda consultar en terminales.

Excelente clase 馃槂

Un consejo que me dieron como Una buena pr谩ctica es: cada funci贸n solo debe realizar una sola actividad, es decir, si tienes un programa para ordenar una lista y encontrar un valor en especifico debes tener dos funciones: una para ordenar y otra para buscar. As铆 te sera m谩s f谩cil para ti y para los dem谩s comprender tu c贸digo.

Usar buena declaraci贸n de variables y funciones puede evitar usar comentarios, pero recuerden el comentario que coloquen debe ser relevante dentro de su c贸digo.

Si el c贸digo es claro considero que no necesita comentarios

馃馃馃
Documentacion:
La primera linea debe ser un resumen, importante que quepa en una sola linea y este separada del resto de docstrings por un espacion en blanco.
El resto de la cadena de documentaci贸n debe describir el comportamiento de la funci贸n.
Se recomienda dejar una l铆nea en blanco antes de las triples comillas que cierran la cadena de documentaci贸n.
馃馃馃

Buenas pr谩cticas:
Recordar que en Python se maneja la indentaci贸n para delimitar bloques de instrucciones. (Hay que ser muy estricto en la sintaxis)
Escribir los programas los m谩s simple posible. (conciso y preciso)

Comentar los programas, explicando el prop贸sito, funcionamiento completo y el resultado esperado.

Al inicio de cada funci贸n, agregar brevemente un comentario que explique el comportamiento
general de la funci贸n.
Definir el nombre de funciones, variables y constantes que mejor representen el contenido que
almacenar谩n.
No usar variables cuyo nombre carezca de significado descriptivo. Con un c贸digo legible y
nombres significativos, el c贸digo se va auto documentado.
Declarar variables en l铆neas separadas, posibilitando agregar una descripci贸n de cada variable
mediante comentarios.
Definir el nombre de funciones, m贸dulos y clases que mejor representen las acciones que
realizan.
Definir el tama帽o de las sangr铆as para que sean regulares (consistentes) y no var铆en a lo largo
del c贸digo, es decir, si el primer bloque ocupa como indentaci贸n una tabulaci贸n, el resto de
bloques deben ser indentados con una tabulaci贸n adicional por cada nivel, con eso se facilita la
lectura en cualquier editor de c贸digo.
Ser consistente al momento de utilizar un est谩ndar para nombres largos, por ejemplo para una
variable que almacena cantidad de alumnos 'contador_alumnos鈥
Comentar cuando sea justo y necesario, usar los comentarios dentro de las funciones para
describir las variables (s贸lo cuando su utilidad sea potencialmente dudosa) y cuando existan
bloques de c贸digo dif铆ciles de entender a primera vista; el exceso de comentarios vuelve ilegible
el c贸digo.
Definir variables locales al inicio de la implementaci贸n de cada funci贸n, como un bloque de
c贸digo bien separado del bloque que contenga las instrucciones ejecutables, 茅sta separaci贸n
puede consistir en una l铆nea en blanco, o bien un comentario que denote la utilidad de cada
bloque.
Evitar la incorporaci贸n de m谩s de una instrucci贸n por l铆nea. Esto reduce notoriamente la
legibilidad del c贸digo, ya que el programador habitualmente est谩 acostumbrado a leer una
instrucci贸n por l铆nea.
Realizar la indentaci贸n necesaria, si una instrucci贸n abarca m谩s de una l铆nea.

Los docstrings son trozos de documentaci贸n que a帽adimos en nuestro c贸digo para especificar que hace esta funci贸n.

  • Deben tener una descripci贸n corta y clara de lo que hace.
  • Se inician con triple comillas doble 鈥溾" 鈥溾"
  • Se describen los par谩metros de la funci贸n y que tipo son.
  • Al final se especifica que resultado retorna.

Les dejo mis apuntes de la clase donde explico m谩s a fondo los docstrings
Apuntes

Documetaci贸n oficial sobre las convenciones para docstrings en python:
https://www.python.org/dev/peps/pep-0257/

yo encontr茅 esta extensi贸n y me pareci贸 realmente sencilla y buena

Genial! A mi me encanta usar los doc strings, en PHP se escriben encima de las funciones con la sintaxis:

/** 
* Descripci贸n
*
* Par谩metro a
* Par谩metro b
* @return value
*/

Si no mal recuerdo era algo as铆 xD

Para conocer la documentaci贸n de una funci贸n usamos:
help(nombre_funci贸n)

1- Breve descripci贸n (que es lo que hace)
2- que acepta como entrada
3- que devuelve

Una buena pr谩ctica que me han recomendado varios conocidos que trabajan en programaci贸n es escribir el c贸digo en ingl茅s. Los comentarios, nombres de las variables, funciones鈥 Todo en ingl茅s.

[2:22] Implementaci贸n en c贸digo: se incluye justo despu茅s de definir la funci贸n al comienzo del bloque de c贸digo. Debe ir debidamente indentado.

[0:24] Instrucciones o comentarios definidos por triple doble comilla. Debe incluir: 1. Que hace la funci贸n. Debes ser conciso y preciso. 2. Que significan los par谩metros y cu谩l es el tipo del par谩metro y que estamos esperando con estos par谩metros. 3. Que es lo que regresa esta funci贸n.

Docstrings
En Python todos los objetos cuentan con una variable especial llamada doc gracias a la que podemos describir para qu茅 sirven y c贸mo se usan los objetos. Estas variables reciben el nombre de docstrings, cadenas de documentaci贸n.

Para comentar en Kotlin:

/**

  • Sum two values
  • @param a any [Int]
  • @param b any [Int]
  • @return the sum of the values
    */
    fun sum(a: Int, b: Int): Int
    Los corchetes generan un URI que te lleva a el archivo de esa clase.

Lo mejor que puedes hacer es crear modularidad y Programaci贸n Orientada Objetos. No solo en Python. En todo lenguaje de programaci贸n

Excelente. Esto es lo que se llaman Buenas Pr谩cticas de Programaci贸n.

No lo sab铆a muy bueno!

Existe algo similar en JS?

interesante desde el punto de vista de buenas practicas

en C# usamos // * *// para documentacion

Especificaciones del c贸digo

La especificacion del c贸digo es un comentario en el que informamos de forma explicita y concisa lo que realizan nuestras instrucciones. Tenemos que tener 3 items importantes en la documentaci贸n:

  1. Que hace la instrucci贸n.
  2. Que significan los parametros.
  3. Que es lo que devuelve nuestra instrucci贸n.
def suma(a, b):
    """Suma dos valores a y b

    param int a cualquier entero
    param int b cualquier entero
    returns la sumatoria de a y b
    """

    total = a + b
    return total

Tema muy importante para poder trabajar en equipo, especialmente si es trabajo remoto.

Dejo un aporte a un buen articulo sobre documentacion https://realpython.com/documenting-python-code/

Recuerden:

  • Los comentarios # Indican que hace una parte de nuestro codigo, podemos agregar en cualquier parte del mismo

  • Los docstrings 鈥溾濃渋ndican como una funcion u objeto hace algo y que resultado esperamos鈥""

Esa s铆 que no la sab铆a, he estado usando Camel Case en Python jejeje

Para funciones se puede agregar una r seguido de las comillas para que al momento de poner el cursor sobre una funci贸n que estamos llamando nos de su descripci贸n:

def enumeracion(objetivo):
    r'''
    objetivo: int = N煤mero del que se desea obtener su raiz cuadrada
    '''
    respuesta = 0 #Inicializaci贸n
    ite = 0
    instanteInicial = datetime.now()

https://www.clubdetecnologia.net/blog/2019/buenas-practicas-en-python/

Encontr茅 este articulo, aunque es documentaci贸n basada mas a deploy y esas cosas

en javascript se utiliza consol茅 log para escribir y ver por pantalla tambi茅n mensajes

Me gusto mucho la forma en que Python documenta las funciones 馃槻

este curso es muy importante para leer e interpretar y saber muy bien lo que estas haciendo, y lo peor de todo es que me da sue帽o y no presto mucha atencion , lo voy a tener que ver y ver hasta que lo entienda bien

A un nivel m谩s fundamental hay otra diferencia a煤n m谩s grande entre los docstrings y los comentarios, y 茅sta tiene que ver con la intenci贸n:
Los docstrings son documentaci贸n, y sirven para entender qu茅 hace el c贸digo.
Los comentarios sirven para explicar c贸mo lo hace.

python -m pydoc <lo-que-queremos-saber>

Es el comando por terminal que nos ofrece python para buscar informaci贸n en Window.

Especificaciones del c贸digo
El docstring es la documentaci贸n de cual es el funcionamiento de una pieza de c贸digo y en Python consta de 3 partes:
鈥 Se da una explicaci贸n muy muy muy precisa de que es lo que hace la funci贸n.
鈥 Se especifica que significa cada uno de los par谩metros(nombre, tipo y que es lo que se espera)
鈥 Al final se especifica que es lo que retorna la funci贸n.
Para a帽adirle un docstring a nuestra funci贸n lo que debemos de hacer es en la primera l铆nea del cuerpo de nuestra funci贸n a帽adir un comentario multil铆nea (usando triple doble comilla 鈥溾濃) y a帽adir como comentario los 3 pasos ya mencionados.
En Python podemos utilizar la funci贸n predefinida help() y pas谩ndole como argumento cualquier otra funci贸n, incluso las que nosotros mismos hayamos creado (siempre y cuando les hayamos colocado un docstring) nos mostrara la documentaci贸n sobre la funci贸n.
Por ejemplo si queremos saber como funciona la funci贸n int podemos ejecutar help(int) y nos mostrara la siguiente documentaci贸n

The docstring for a module function should include the same items as a class method:

  • A brief description of what the function is and what it鈥檚 used for.
  • Any arguments (both required and optional) that are passed including keyword arguments.
  • Label any arguments that are considered optional.

Les dejo una extensi贸n muy buena para VSC que ayuda con el

docstring
https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

鈥溾濃済racias鈥""

鈥溾" Primero: que hace la funci贸n (conciso y preciso).
Segundo: par谩metro (nombre, tipo, y que esperamos).
Tercero: que es lo que regresa la funci贸n.
"""

no es un lenguaje, pero en html los comentarios son asi:

<!鈥 Aqui va el comentario    鈥> 

a lo mejor le sirve a alguien

Nunca hab铆a escuchado de esa forma de documentar y obtener informaci贸n gracias.

docstring =! comentarios?

驴El docstring siempre va dentro de la funci贸n? no se puede hace antes de la funci贸n como se hace en java

Excelente resumen

Ctrl + / en CUALQUIER es el atajo de teclado UNIVERSAL para comentar una l铆nea de c贸digo escrita.
Este atajo funcionar谩 en cualquier lenguaje de programaci贸n y en cualquier IDE o editor de c贸digo

驴exite algo c贸mo los docstrings en C#?

Muy importante la documentaci贸n.

Buenas practicas. Excelente clase.

Aparte de usar Docstrings, existen otros programas o herramientas como pytest, PEP8 y Git o bien, hacer un refactoring sirven para mejorar el c贸digo en Python.