PYTHON Documentación con Docstring [85]

La documentación de nuestro software siempre a sido un dolor de cabeza para los desarrolladores pero esto no tiene que ser siempre así (al menos no en python) ya que este lenguaje nos ofrece un mecanismo documentación intrínseco al codigo (osea que la documentación es parte del código).

Python no ofrece la herramienta docstring que se encarga de leer los comentarios que coloquemos en nuestro código (comentarios estratégicamente colocados) y nos retornara esos comentarios como documentación, algunos métodos de docstring encontramos:
__name__
__doc__

Codigo: https://github.com/programadornovato/curso-python/commit/1d273af4f3f51d335a280d4a0f990675e51dc7bd

def funcionQueHacealgo():
    '''Esta funcion por ahora no hace nada pero va hacer algo muy importante que va a cambiar el mundo'''
    pass
def funcionQueHacealgo2():
    '''Esta otra funcion por ahora no hace nada pero va hacer algo muy importante que va a cambiar el mundo'''
    pass
def funcionQueHacealgo3():
    '''Esta otra funcion por ahora no hace nada pero va hacer algo muy importante que va a cambiar el mundo'''
    pass
'''
print("NOMBRE DE NUESTRA FUNCION:",funcionQueHacealgo2.__name__)
print("DOCUMENTACION DE NUESTRA FUNCION:",funcionQueHacealgo2.__doc__)
'''

https://www.youtube.com/watch?v=GjeXCFbT988&list=PLCTD_CpMeEKRppvi86Dy8CPYZ8-XzN2qu&index=87&t=339s

🎦Curso de Java Netbeans Completo☕ [62.- Documentación automática con java y netbeans]: https://www.youtube.com/watch?v=mT6HL9Wdwjc 🎦[CURSO] PYTHON PARA PRINCIPIANTES🐍: https://www.youtube.com/playlist?list=PLCTD_CpMeEKRppvi86Dy8CPYZ8-XzN2qu

🔗 Gracias por apoyar este canal: https://www.patreon.com/programadornovato
🔗 Facebook: https://facebook.com/ProgramadorNovatoOficial
🔗 Twitter: https://twitter.com/programadornova
🔗 Linkedin: https://www.linkedin.com/in/programadornovato/
🔗 Instagram: https://www.instagram.com/programadornovato/
🔗 Pagina oficial: https://www.programadornovato.com
🎦 Canal de youtube: https://www.youtube.com/c/programadornovato

Eugenio Chaparro

Entradas recientes

🟢Editar código de un módulo en Dolibarr [04]

🟢Editar código de un módulo en Dolibarr [04]

En este tutorial vamos editar el código de nuestro módulo personas para poder personalizar algunas…

2 meses hace
🟢Crear un sub_módulo en Dolibarr [03]

🟢Crear un sub_módulo en Dolibarr [03]

En este tutorial vamos a crear un sub módulo llamado seguridad que será muy parecido…

2 meses hace
🟢Modificar un módulo en Dolibarr [02]

🟢Modificar un módulo en Dolibarr [02]

En este tutorial aprenderemos a editar el objeto personas del modulo persona que creamos en…

2 meses hace
🟢Constructor de módulos en Dolibarr

🟢Constructor de módulos en Dolibarr

Como mencionamos anteriormente Dolibarr es un proyecto realizado sobre la base de una política clara:…

2 meses hace
🟢Tickets en Dolibarr [19]

🟢Tickets en Dolibarr [19]

Los ticket en dolibarr nos ayudan a comunicar inconveniente en nuestros productos y servicios dentro…

2 meses hace
🟢Agenda en Dolibarr [18]

🟢Agenda en Dolibarr [18]

Las agendas en dolibarr nos ayudan a ver las actividades realizadas en proceso y por…

2 meses hace