Portal    Foro    Buscar    FAQ    Registrarse    Conectarse


Publicar nuevo tema  Responder al tema 
Página 1 de 3
Ir a la página 1, 2, 3  Siguiente
 
Documentar Función
Autor Mensaje
Responder citando   Descargar mensaje  
Mensaje 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
 




===================
Gambas Básico
“Si no puedes explicar algo de forma sencilla, entonces es que tú no lo entiendes bien.” Albert Einstein
 
última edición por Shell el Lunes, 26 May 2014, 13:03; editado 2 veces 
Shell - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje 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"
 
jguardon - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje 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
 




===================
Gambas Básico
“Si no puedes explicar algo de forma sencilla, entonces es que tú no lo entiendes bien.” Albert Einstein
 
Shell - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje 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 Miercoles, 28 May 2014, 00:30; editado 9 veces 
vuott - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje 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
“Si no puedes explicar algo de forma sencilla, entonces es que tú no lo entiendes bien.” Albert Einstein
 
Shell - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
...puedes enriquecer mucho el texto de ayuda, incluso añadiendo imágenes, sonidos, etc ..!
 



 
vuott - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje 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.
 




===================
Blog personal
Web: SoloGambas seleccion de articulos dedicados a Gambas
Visita el Curso de Gambas3 ¡¡¡Gratuito!!!
 
jsbsan - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
vuott escribió:  


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


 



 
gambafeliz - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
gambafeliz escribió:  
abrir una galaxia

Yo realmente esperaría encontrar un agujero de gusano !  
 



 
vuott - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
vuott escribió:  
gambafeliz escribió:  
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.


 



 
gambafeliz - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Mostrar mensajes anteriores:    
 
Ocultar¡Este tema fue útil?

 

Elegir valoración:                       

Media de valoración Valoración mínima Valoración máxima Número de valoraciones
0.00 0 0 0
 
OcultarTemas parecidos
Tema Autor Foro Respuestas último mensaje
No hay nuevos mensajes Función Atan2 RIKL Controles/Librerías/Componentes 4 Viernes, 13 Julio 2012, 13:11 Ver último mensaje
RIKL
No hay nuevos mensajes Función Min Shell General 9 Domingo, 10 Abril 2016, 15:52 Ver último mensaje
v3ctor
No hay nuevos mensajes Función CDate Shell General 20 Sabado, 28 Abril 2018, 10:04 Ver último mensaje
Shell
No hay nuevos mensajes Documentar Componente Guizans Controles/Librerías/Componentes 4 Martes, 19 Febrero 2019, 16:18 Ver último mensaje
Guizans
 

Publicar nuevo tema  Responder al tema  Página 1 de 3
Ir a la página 1, 2, 3  Siguiente

Usuarios navegando en este tema: 0 registrados, 0 ocultos y 1 invitado
Usuarios registrados conectados: Ninguno


 
Lista de permisos
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
No puede descargar archivos
No puede publicar eventos en el calendario