Portal    Foro    Buscar    FAQ    Registrarse    Conectarse


Publicar nuevo tema  Responder al tema 
Página 1 de 1
 
 
Sobre Como Comentar El Código.
Autor Mensaje
Responder citando   Descargar mensaje  
Mensaje Sobre Como Comentar El Código. 
 
Hola a todos.
Cada uno comenta el código según su comodidad o gusto, pero... ¿Existen algunas normas de estilo? La finalidad, por supuesto, es que al leer el código de otros programadores nos sea mas fácil de entender.
Por ejemplo, lo harían así...
Print "Hola gamberas y gamberos !!" ' Esta sentencia imprime en la salida la frase Hola "gamberas y gamberos !!"
 

así....
' La siguiente línea imprime en la salida la frase Hola "gamberas y gamberos !!"
Print "Hola gamberas y gamberos !!"
 

¿O de otra manera?

Nota: Todo viene porque estoy programando una rutina que escanee todo el código gambas de un directorio que se la pasa y devuelva una matriz con toda la información ordenada y accesible para, por ejemplo, buscar fragmentos de código o hacer mapas mentales o de flujo del programa, etc.

Saludos.
 



 
tincho - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Sobre Como Comentar El Código. 
 
Hola  tincho,

mi manera

para variable, properties, o cualquier cosa que cree y es parte de una clase o propiedad que pueda salir en el cuadro de dialogo que desplega gambas como ayuda uso esto con la comilla simple dos veces

Private $oVar as Object '' variable global , este texto aparece en la ayuda de gambas cuando escribes la variable

private sub metodo(param1, as string, param2 as integer) ''metodo que hace tal y cual cosa
 


para dejar comentarios dentro del codigo uso la comilla simple una vez

'ciclo que calcula el año de vida de la tortuga
for i = 0 to 10
   ' calculo pensando en la fecha de nacimiento, y le sumo 1
   Inc edad
next
 

 




===================
------
Telegram : @sepulvedamarcos
 
chaskux - Ver perfil del usuarioEnviar mensaje privado 
Volver arribaPágina inferior
Responder citando   Descargar mensaje  
Mensaje Re: Sobre Como Comentar El Código. 
 
Tincho:


Citar:
buscar fragmentos de código o hacer mapas mentales o de flujo del programa,


Para darte ideas,un programa que hice para gambas2:
http://jsbsan.blogspot.com.es/2012/...-programas.html
 




===================
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: Sobre Como Comentar El Código. 
 
jsbsan escribió:  
Para darte ideas,un programa que hice para gambas2

Gracias, ya conocía tu programa, hace bastante tiempo lo use, ahora no se por que no arroja los gráficos. (instale graphviz ).
De momento estaba haciendo unas pruebas con LaTex pero es un poco mas complicado.
Ya estoy en el punto de leer todo los proyectos de un directorio, su información relevante, y también el código que estos contienen para indexar y hacer búsquedas. Luego también dispongo de una matriz de texto con la información de referencias entre módulos, clases etc.
En cuanto termine esta etapa le echare un vistazo a DotGambas para ver como funciona.

Saludos.
 



 
tincho - 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 Pregunta Sobre Código aaRon General 3 Viernes, 26 Marzo 2010, 17:50 Ver último mensaje
jguardon
No hay nuevos mensajes Desanclar Un Modulo Y Comentar Líneas Shell General 1 Lunes, 17 Octobre 2016, 15:43 Ver último mensaje
Shell
No hay nuevos mensajes Como Ver Código Fuente De Un Proyecto X E... v3ctor C/C++ 1 Lunes, 07 Agosto 2017, 00:36 Ver último mensaje
jguardon
No hay nuevos mensajes Duda Sobre La Programación En Gambas, Usa... gambafeliz General 6 Sabado, 07 Septiembre 2019, 07:22 Ver último mensaje
gambafeliz
 

Publicar nuevo tema  Responder al tema  Página 1 de 1
 

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