Documentar Función


Ir a la página 1, 2, 3  Siguiente

Objetivo: 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:

Public Function Sumar(a As Integer, b As Integer) As Integer '' Devuelve la suma de dos números

Return (a + b)

End


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:
'' linea 1
'' linea 2


Saludos

última edición por Shell el Lunes, 26 May 2014, 12:03; editado 2 veces
Objetivo: 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

Perfil MP  
Objetivo: Re: Documentar Función
Hola Jesús.

He hecho lo que dices, colocar los comentarios con doble apostrofes arriba. ( Queda de otra forma)

documentar_funcion_imagen1

Y he probado a expandir la ventana de documentación. Es como si fuera todo una linea.

documentar_funcion_ventana_expandida

Ahora fíjate en la documentación de Print. No se ajusta el texto, aunque expanda la ventana.

prueba_doc_con_print

Parece dos cosas distintas.

Saludos

Objetivo: 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
Perfil MP  
Objetivo: 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

Objetivo: Re: Documentar Función
...puedes enriquecer mucho el texto de ayuda, incluso añadiendo imágenes, sonidos, etc ..!

Perfil MP  
Objetivo: 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.

Objetivo: Re: Documentar Función
vuott escribió: [Ver mensaje]


'' 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.


Perfil MP  
Objetivo: Re: Documentar Función
gambafeliz escribió: [Ver mensaje]
abrir una galaxia

Yo realmente esperaría encontrar un agujero de gusano !

Perfil MP  
Objetivo: Re: Documentar Función
vuott escribió: [Ver mensaje]
gambafeliz escribió: [Ver mensaje]
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.


Perfil MP  
Ir a la página 1, 2, 3  Siguiente

Página 1 de 3


  
No puede crear mensajes
No puede responder temas
No puede editar sus mensajes
No puede borrar sus mensajes
No puede votar en encuestas
No puede adjuntar archivos
Puede descargar archivos
No puede publicar eventos en el calendario

   

Está utilizando la versión (Lo-Fi). Para ver la versión completa del foro, haga clic aquí.

Powered by Icy Phoenix based on phpBB
Design by DiDiDaDo

Página generada en:: 3.9047s (PHP: -98% SQL: 198%)
Consultas SQL: 47 - Debug off - GZIP Activado