Documentar Función


Goto page 1, 2, 3  Next

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

Last edited by Shell on Monday, 26 May 2014, 12:03; edited 2 times in total
Subject: 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

Profile PM  
Subject: 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

Subject: 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 ........

Last edited by vuott on Tuesday, 27 May 2014, 23:30; edited 9 times in total
Profile PM  
Subject: 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

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

Profile PM  
Subject: 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.

Subject: 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.


Profile PM  
Subject: Re: Documentar Función
gambafeliz escribió: [Ver mensaje]
abrir una galaxia

Yo realmente esperaría encontrar un agujero de gusano !

Profile PM  
Subject: 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.


Profile PM  
Goto page 1, 2, 3  Next

Page 1 of 3


  
You cannot post new topics
You cannot reply to topics
You cannot edit your posts
You cannot delete your posts
You cannot vote in polls
You cannot attach files
You can download files
You cannot post calendar events

   

This is a "Lo-Fi" version of our main content. To view the full version with more information, formatting and images, please click here.

Powered by Icy Phoenix based on phpBB
Design by DiDiDaDo

Generation Time: 0.1106s (PHP: -23% SQL: 123%)
SQL queries: 25 - Debug Off - GZIP Enabled