Lo ideal es crear una API, que describa que es, que hace, cada objeto. ¿Qué sucede? Que a la larga es difícil de mantener, da pereza, etc.
Y ahí es cuando Python entra con su maravilloso docstrings.
Esta documentación tiene una serie de reglas, a saber:
- Cualquier clase, función o método puede tener un string Python estándar que tiene que localizarse en la primera línea después de la definición (la línea que termina con dos puntos).
- Ésta línea deberá estar identada al mismo nivel que el código que contenga la clase, función o método.
- Debe explicar los parámetros que no queden muy claros
- En caso de que se retorne algún valor también deberá indicarse
Es decir, que nuestra clase que llevamos trabajando en las anteriores entradas quedaría tal que así:
class NombreDeLaClase: ''' Establece una fecha basada en el día y el mes ''' def __init__(self, dia, mes): ''' Inicializa la nueva fecha Params: - dia. Entero indicando el día de la fecha - mes. Entero indicando el mes de la fecha ''' self.nueva_fecha(dia, mes) def nueva_fecha(self, dia, mes): ''' Establece una nueva fecha Params: - dia. Entero indicando el día de la fecha - mes. Entero indicando el mes de la fecha ''' self.dia = dia self.mes = mes def reiniciar(self): ''' Reinicia la fecha a un valor por defecto Params: - 1. Entero. Día - 1. Entero. Mes ''' self.nueva_fecha(1, 1) def diferencia_mes(self, otra_fecha): ''' Devuelve la diferencia de meses entre dos fechas Params: - self. Nuestro objeto - otra_fecha. Objeto NombreDeLaClase inicializado Returns: - Entero indicando la diferencia de meses ''' if (self.mes > otra_fecha.mes): return self.mes - otra_fecha.mes else: return otra_fecha.mes - self.mesAhora guardaremos el archivo con un nombre de nuestra elección. En mi caso, ejemploDocstrings.py.
Nos vamos a la consola de comandos y lanzamos nuestro programa en modo interacción con el siguiente comando
python -i ejemploDocstrings.pyNos aparecerá un prompt esperando nuestros comandos, cosas que indica que nuestra clase ya se ha cargado y, si queremos ver el docstring en formato API que nos genera Python, escribiremos
help(NombreDeLaClase)y veremos como automaticamente nos aparece un documento con los comentarios que hemos creado
Al poder crearse tan sencillamente, incluso podemos crearnos un script que con cada actualización nos genere la documentación de nuestro proyecto, para tenerlo constantemente actualizado.
Pronto regresare con una nueva entrada
I like your blog, I read this blog please update more content on python, further check it once at python online course
ResponderEliminarHi! Thanks for your comment. Right now I'm learning about Python oriented to Machine Learning, so in a future (when my work allows me) I continue writing about this topic.
ResponderEliminarSee you!
kayseriescortu.com - alacam.org - xescortun.com
ResponderEliminarbeğeni satın al
ResponderEliminarinstagram takipçi satın al
ucuz takipçi
takipçi satın al
https://takipcikenti.com
https://ucsatinal.org
instagram takipçi satın al
https://perdemodelleri.org
https://yazanadam.com
instagram takipçi satın al
balon perdeler
petek üstü perde
mutfak tül modelleri
kısa perde modelleri
fon perde modelleri
tül perde modelleri
https://atakanmedya.com
https://fatihmedya.com
https://smmpaketleri.com
https://takipcialdim.com
https://yazanadam.com
yasaklı sitelere giriş
aşk kitapları
yabancı şarkılar
sigorta sorgula
https://cozumlec.com
word indir ücretsiz
tiktok jeton hilesi
rastgele görüntülü sohbet
erkek spor ayakkabı
fitness moves
gym workouts
https://marsbahiscasino.org
http://4mcafee.com
http://paydayloansonlineare.com
seo fiyatları
ResponderEliminarsaç ekimi
dedektör
instagram takipçi satın al
ankara evden eve nakliyat
fantezi iç giyim
sosyal medya yönetimi
mobil ödeme bozdurma
kripto para nasıl alınır
bitcoin nasıl alınır
ResponderEliminartiktok jeton hilesi
youtube abone satın al
gate io güvenilir mi
binance referans kimliği nedir
tiktok takipçi satın al
bitcoin nasıl alınır
mobil ödeme bozdurma
mobil ödeme bozdurma
mmorpg oyunlar
ResponderEliminarinstagram takipçi satın al
tiktok jeton hilesi
tiktok jeton hilesi
antalya saç ekimi
referans kimliği nedir
İnstagram Takipçi Satın Al
Mt2 Pvp Serverler
Instagram takipçi
Smm Panel
ResponderEliminarSMM PANEL
is ilanlari
İnstagram takipçi satın al
HİRDAVATCİ
beyazesyateknikservisi.com.tr
SERVİS
tiktok hile indir
Good text Write good content success. Thank you
ResponderEliminarkibris bahis siteleri
tipobet
betmatik
poker siteleri
mobil ödeme bahis
betpark
slot siteleri
kralbet