Portal    Foro    Buscar    FAQ    Registrarse    Conectarse


Publicar nuevo tema  Responder al tema 
Página 2 de 3
Ir a la página Anterior  1, 2, 3  Siguiente
 
Documentar Función
Autor Mensaje
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Oscuras oquedades aparte,       , conste que ha de ir justo antes de la función, con doble apóstrofo más un espacio —si el texto va pegado a los apóstrofes, o es una tabulación o un espacio duro, passsha de to' y no lo presenta como ayuda—.
Y la etiqueta <table> e hijos, <tr> y <td>, no se las come. Lo juro. —O soy muy torpe, que también.—

Explorando un poco la ayuda, he visto esto para más detalle:

http://gambaswiki.org/wiki/doc/helpcomments
http://gambaswiki.org/wiki/doc/markdown

O sea, el formato nativo es markdown, que admite código html. Voy a probar unas cuantas cosas...     
 



 
última edición por Grandamakulo el Miercoles, 16 Octobre 2019, 16:39; editado 2 veces 
Grandamakulo - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Grandamakulo escribió:  
markdown, que admite código html. Voy a probar unas cuantas cosas...

Por ejemplo, has visto esto ?
https://www.gambas-es.org/show_post.php?p=21852
 



 
vuott - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Grandamakulo escribió:  
Oscuras oquedades aparte,       , conste que ha de ir justo antes de la función, con doble apóstrofo más un espacio —si el texto va pegado a los apóstrofes, o es una tabulación o un espacio duro, passsha de to' y no lo presenta como ayuda—.
Y la etiqueta <table> e hijos, <tr> y <td>, no se las come. Lo juro. —O soy muy torpe, que también.—

Explorando un poco la ayuda, he visto esto para más detalle:

http://gambaswiki.org/wiki/doc/helpcomments
http://gambaswiki.org/wiki/doc/markdown

O sea, el formato nativo es markdown, que admite código html. Voy a probar unas cuantas cosas...     


Dioooss !!!

Ahora no solo veo las galaxias ahora veo el agujero de gusano      

Enserio, buenísimo con esto se puede hace una buena documentación.

Pero tengo una duda.

Os la cuento a ambos, miradlo como si de un usuario se tratara. Como ya ha apuntado Grandamakulo (vaya tela) lo de como ponerse que yo ya lo he hecho antes de su explicación. etc etc.

Mirad cuando uno hace esta documentación sobre por ejemplo una función, uno escribe en por ejemplo HTML pero queda feo, refeo antes de la función pues no pensais que en el IDE uno escribe en HTML para documentar pero que cuando lo termines de escribir tome la forma Visor HTML para que no se vea el lenguaje de Marcación y que si lo quieres editar nuevamente tengas que clickar 2 veces para que se ponga en la forma HTML para ser editado?

Seria mejor, mas educativo y mucho mas humano, no?

¿Que piensa ustedes sobre mi forma de verlo?
 



 
última edición por gambafeliz el Miercoles, 16 Octobre 2019, 20:23; editado 1 vez 
gambafeliz - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Estimado vuott, frater italica, por supuesto que he visto tales ejemplos, que son los que me han animado a seguir buscando. De hecho, lo que yo pretendía —y ahora he conseguido— es algo como esto:

'' <table><tr><th>Descripción:</th><th>Esta función devuelve un color de tinta que sea contrastante con un color de fondo y que resulte legible.</th></tr><tr><td rowspan="3">Entradas:</td><td>Colorfondo:</td><td colspan="2">El color sobre el que hay que escribir</td></tr><tr><td rowspan="2">booTotal:</td><td>Si:</td><td>devuelve blanco o negro, según la luminancia</td></tr><tr><td>No:</td><td>devuelve un color con el matiz girado 60º en la rueda cromática.</td></tr><tr><td>Salidas:</td><td colspan="3">Devuelve el color de tinta adecuado para ese fondo</td></tr><tr><td>Notas:</td><td colspan="3"></td></tr></table>
Public Function TintaxContraste(Colorfondo As Integer, booTotal As Boolean) As Integer
'╔══════════════╦══════════════════════════════════════════════════════════════════╗
'║ Descripción: ║ Esta función devuelve un color de tinta que sea contrastante con ║
'║              ║ un color de fondo y que resulte legible.                         ║
'╠══════════════╬═════════════╦════════════════════════════════════════════════════╣
'║ Entradas:    ║ Colorfondo: ║ El color sobre el que hay que escribir             ║
'║              ╠═════════════╬═════╦══════════════════════════════════════════════╣
'║              ║ booTotal:   ║ Si: ║ devuelve blanco o negro, según la luminancia ║
'║              ║             ╠═════╬══════════════════════════════════════════════╣
'║              ║             ║ No: ║ devuelve un color con el matiz girado 60º en ║
'║              ║             ║     ║ la rueda cromática.                          ║
'╠══════════════╬═════════════╩═════╩══════════════════════════════════════════════╣
'║ Salidas:     ║ Devuelve el color de tinta adecuado para ese fondo               ║
'╠══════════════╬══════════════════════════════════════════════════════════════════╣
'║ Notas:       ║                                                                  ║
'╚══════════════╩══════════════════════════════════════════════════════════════════╝

...

 




Estimado Crustáceo Contento   , creo que poniéndolo una línea, como en el código de ejemplo —en el IDE queda muuucho mejor—, iría bien, aunque estoy de acuerdo con usted. Lo siguiente, supongo, sería ver cómo va lo del archivo .info.

PS.—Las tablas las genero con https://www.tablesgenerator.com. Así la HTML me vale para la ayuda y la TEXT me vale para la documentación, pero es la misma.
 



 
última edición por Grandamakulo el Miercoles, 16 Octobre 2019, 23:11; editado 1 vez 
Grandamakulo - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
[quote user="Grandamakulo" post="46902"]
'' <table><tr><th>Descripción:</th><th>Esta función devuelve un color de tinta que sea contrastante con un color de fondo y que resulte legible.</th></tr><tr><td rowspan="3">Entradas:</td><td>Colorfondo:</td><td colspan="2">El color sobre el que hay que escribir</td></tr><tr><td rowspan="2">booTotal:</td><td>Si:</td><td>devuelve blanco o negro, según la luminancia</td></tr><tr><td>No:</td><td>devuelve un color con el matiz girado 60º en la rueda cromática.</td></tr><tr><td>Salidas:</td><td colspan="3">Devuelve el color de tinta adecuado para ese fondo</td></tr><tr><td>Notas:</td><td colspan="3"></td></tr></table>
 


También lo intuí y lo probé antes de tu info. Con esto no quiero decirte nada. Pero como ya te he dicho, esto esta bien de cara a la programación, propiamente dicho pero cuando tu o yo estamos escribiendo código, hay dos tipos de usuarios, el que escribe tu historia de código como programador y el usuario que esta documentando su código. Si lo pensamos no tiene ningún sentido como documentarista ver código atropellado en html, esto es una Gamba=(Error de diseño), a lo mejor algún día alguien lo corrige, para mi no tiene ningún sentido y además, is very easy fix it. Digo yo!!! que hasta yo sé hacerlo.

Y se que tu no me dices nada. Es solo por que soy R que R.

Citar:
Estimado Crustáceo Contento   ,


Como tengo peques me has transportado a ese ser cuadrado amarillo que ya estoy hasta el moño de el "Crustáceo crujiente" o algo así        

Es que tu Nick me es muy complicado, ¿cual es su historia mas o menos la puedes contar?, si es algo privado, no claro.

Nota: +10 por tu enlace para ayudar con html tipo tabla etc
 



 
última edición por gambafeliz el Jueves, 17 Octobre 2019, 11:47; editado 1 vez 
gambafeliz - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
gambafeliz escribió:  
Es que tu Nick me es muy complicado, ¿cual es su historia mas o menos la puedes contar?, si es algo privado, no claro.


Aunque se salga un tanto del tema, el nombre viene de pequeño, cuando por una anécdota me llamaron «la gran mancha». Al principio lo empleé en latín como magna macula y ahora en esperanto, granda makulo.
Y ya está  
 



 
Grandamakulo - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Grandamakulo escribió:  
gambafeliz escribió:  
Es que tu Nick me es muy complicado, ¿cual es su historia mas o menos la puedes contar?, si es algo privado, no claro.


Aunque se salga un tanto del tema, el nombre viene de pequeño, cuando por una anécdota me llamaron «la gran mancha». Al principio lo empleé en latín como magna macula y ahora en esperanto, granda makulo.
Y ya está  


Pero que personaje tan culto eres. Pues mi saludo formal, es un placer de verdad poder conversar contigo.

Saludos y gracias por tu anécdota.
 



 
última edición por gambafeliz el Jueves, 17 Octobre 2019, 13:18; editado 1 vez 
gambafeliz - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Estoy rompiéndome el coco para poner fragmentos de código en la ayuda de las funciones que creo pero no lo consigo, por lo menos con un resaltado de sintaxis como en la ayuda que aparece de las funciones que cargan la ayuda desde la web.
Saludos.
 



 
tincho - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Se me ocurre, tincho, que podría hacerse con las etiquetas <PRE> y <FONT>, pero no me he puesto a probarlo. Las sangrías en markdown van con ">". ¿Alguien se anima a hacer un ejemplo? Mi pereza me puede.
 



 
Grandamakulo - Ver perfil del usuarioEnviar mensaje privadoVisitar sitio web del usuario 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Documentar Función 
 
Grandamakulo escribió:  
...con las etiquetas <PRE> y <FONT>

Dices como este ejemplo ?

'' <FONT Color=orange>Esta es una Constante de tipo Integer</font>
Private Const EXEMPLUM As Integer = 21081969

 



 
vuott - 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 2 de 3
Ir a la página Anterior  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