| Autor |
Mensaje |
 Shell 
Analista Programador
Registrado: Marzo 2010
Mensajes: 5278
Edad: 53 Ubicación:  Al otro lado de la pantalla
|
 Documentar Función
Hola!.
Acostumbrado a la manera en como se documenta una función en Python, estuve buscando lo mas
parecido en gambas, con los dobles apostrofe.
Ejemplo:
Hay funciones en la que gambas nos muestra la ayuda sobre esta y aparentemente tiene
mas de una linea. Hay divisiones, enlaces,etc.
Puedo continuar la linea de ayuda y hacerla mas larga, pero y si yo quiero hacer algo como esto:
Saludos
=================== Gambas Básico
"No es un bug, es una característica no documentada"
última edición por Shell el Lunes, 26 May 2014, 12:03; editado 2 veces |
#1 Lunes, 26 May 2014, 10:31 |
|
 |
jguardon
Administrador
Registrado: Septiembre 2009
Mensajes: 2708
Edad: 57 Ubicación: Granada
|
Re: Documentar Función
Ahora mismo no tengo un PC con Linux y gambas delante, pero si mal no recuerdo, eso se puede hacer. Prueba poniendo las líneas de documentación justo antes de la función o justo después (dentro) de la función. No es muy ortodoxo poner el comentario doc a continuación de la función en la misma línea...
Saludos
===================
Jesús Guardón
Por favor, usemos el corrector ortográfico antes de pulsar el botón "Enviar".
"uo ǝs ʇɐu pıɟıɔıן ɐdɹǝupǝɹ ɐ dɹoƃɹɐɯɐɹ, soןo ɥɐʎ bnǝ dɹodouǝɹsǝןo"
|
#2 Lunes, 26 May 2014, 15:46 |
|
|
Shell
Analista Programador
Registrado: Marzo 2010
Mensajes: 5278
Edad: 53 Ubicación: Al otro lado de la pantalla
|
Re: Documentar Función
Hola Jesús.
He hecho lo que dices, colocar los comentarios con doble apostrofes arriba. ( Queda de otra forma)
Y he probado a expandir la ventana de documentación. Es como si fuera todo una linea. 
Ahora fíjate en la documentación de Print. No se ajusta el texto, aunque expanda la ventana.
Parece dos cosas distintas.
Saludos
=================== Gambas Básico
"No es un bug, es una característica no documentada"
|
#3 Lunes, 26 May 2014, 18:48 |
|
|
vuott
Analista Programador
Registrado: Agosto 2013
Mensajes: 2086
Edad: 60 Ubicación: 
|
Re: Documentar Función
'' <FONT color=red>Hispania</font>, Italia, Graecia Europae magnae
'' <BR>paeninsulae sunt.
Public Function.........
y tambien.....
'' Nunc audere archivium musicale possumus:
'' <BR>Para escuchar el archivo WAV, <A href='/ruta/de/un/file.wav'><B>haga clic aquí !</b></a>
Public Sub ........ '' Ahora vamos a mirar una imagen:
'' <BR><IMG src='/ruta/de/una/imagen'>
Public sub........ '' y porque no un video ?
'' <BR>Para ver el video, <A href='/ruta/de/un/video'><B>haga clic aquí !</b></a>
Public Sub ........
última edición por vuott el Martes, 27 May 2014, 23:30; editado 9 veces |
#4 Martes, 27 May 2014, 00:50 |
|
|
Shell
Analista Programador
Registrado: Marzo 2010
Mensajes: 5278
Edad: 53 Ubicación: Al otro lado de la pantalla
|
Re: Documentar Función
Vuott:
Entonces si aprendo a usar las etiquetas html puedo lograr mejorar la documentación
de las funciones. ¿ Tanto como muestra la ayuda en gambas ?.
Quizás no todas las etiquetas funcionen, solo algunas.
Ha funcionado mejor usando la etiqueta retorno de linea. <BR>
Gracias
=================== Gambas Básico
"No es un bug, es una característica no documentada"
|
#5 Martes, 27 May 2014, 08:02 |
|
|
vuott
Analista Programador
Registrado: Agosto 2013
Mensajes: 2086
Edad: 60 Ubicación:
|
Re: Documentar Función
...puedes enriquecer mucho el texto de ayuda, incluso añadiendo imágenes, sonidos, etc ..!
|
#6 Martes, 27 May 2014, 08:40 |
|
|
jsbsan
Analista Programador
Registrado: Septiembre 2009
Mensajes: 4175
Edad: 50 Ubicación: dos hermanas, sevilla
|
Re: Documentar Función
Citar:
...puedes enriquecer mucho el texto de ayuda, incluso añadiendo imágenes, sonidos, etc ..!
Guauuuu!!!! 
Esto va directo para añadirlo al curso..... se puede montar una ayuda impresionante para el que revise o desee reusar el código.
|
#7 Martes, 27 May 2014, 09:27 |
|
|
gambafeliz
Analista Programador
Registrado: Julio 2019
Mensajes: 830
Edad: 54
|
Re: Documentar Función
'' y porque no un video ?
'' <BR>Para ver el video, <A><B>haga clic aquí !</b></a>
Public Sub ........
Muchísimas gracias a todos por este tema tan interesante.
Mis gracias especialmente a vuott por abrir una galaxia ante mis ojos.
|
#8 Martes, 15 Octobre 2019, 15:15 |
|
|
vuott
Analista Programador
Registrado: Agosto 2013
Mensajes: 2086
Edad: 60 Ubicación:
|
Re: Documentar Función
abrir una galaxia
Yo realmente esperaría encontrar un agujero de gusano ! 
|
#9 Martes, 15 Octobre 2019, 15:29 |
|
|
gambafeliz
Analista Programador
Registrado: Julio 2019
Mensajes: 830
Edad: 54
|
Re: Documentar Función
abrir una galaxia
Yo realmente esperaría encontrar un agujero de gusano !
Si no vamos a decir agujero negro que se va a mal-interpretar con algo como una Miss Italia o algo así.
Saludos, me alegra saludarte.
|
#10 Martes, 15 Octobre 2019, 15:35 |
|
|
|
|
