85

Documentación con Docstring en Python [85]

En este tutorial vamos a analizar la documentación con docstring en Python:

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__

Documentación con Docstring en Python

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

Siguiente tutorial >>

Ads Blocker Image Powered by Code Help Pro

Ads Blocker Detected!!!

En Programador Novato vivimos de los anuncios, hemos detectado que está utilizando extensiones para bloquear anuncios. Ayudanos deshabilitando tu bloqueador de anuncios. :)