FiveTech Support Forums

FiveWin / Harbour / xBase community
Board index FiveWin para Harbour/xHarbour Documentador autom谩tico de c贸digo?
Posts: 728
Joined: Fri Oct 07, 2005 07:38 AM
Documentador autom谩tico de c贸digo?
Posted: Mon Sep 21, 2020 02:31 PM

Vuelvo con consultas, ten茅is alguna experiencia con documentadores atom谩ticos de c贸digo?
Estoy testeando doxygen y naturaldocs ahora mismo con resultados bastante prometedores.

Angel Salom
Visionwin Software - https://www.visionwin.com
------------------------------------------------------------
fwh 19.05 - harbour 3.2 - bcc 7.4
Posts: 6983
Joined: Fri Oct 07, 2005 07:07 PM
Re: Documentador autom谩tico de c贸digo?
Posted: Tue Sep 22, 2020 03:10 PM

Hello Angel,

Gracias por tu aporte. Mir茅 los productos.
Recib铆 algunas sugerencias para mi propio programa "HARBOURINO".

En "HARBOURINO" utilizo

|- para comentarios

en "incluir archivos" - esto no se muestra en el archivo prg de la versi贸n "parcheada".

VS-Code puede abrir enlaces http directamente desde el editor.
Creo que puedo agregar a煤n m谩s comentarios de esa manera.

Gracias nuevamente por abordar la documentaci贸n del c贸digo fuente.

Best regards,
Otto
La documentaci贸n se trata.

Posts: 728
Joined: Fri Oct 07, 2005 07:38 AM
Re: Documentador autom谩tico de c贸digo?
Posted: Tue Sep 22, 2020 03:55 PM
Mi intenci贸n es darle un uso interno para documentar las clases de uso gen茅rico.
Con Natural docs (https://naturaldocs.org/) estoy consiguiendo un resultado muy bueno simplemente ajustando algunos par谩metros de la configuraci贸n :

Angel Salom
Visionwin Software - https://www.visionwin.com
------------------------------------------------------------
fwh 19.05 - harbour 3.2 - bcc 7.4
Posts: 6755
Joined: Wed Feb 15, 2012 08:25 PM
Re: Documentador autom谩tico de c贸digo?
Posted: Tue Sep 22, 2020 06:22 PM

Gracias Angel por compartirlo
Qu茅 configuraci贸n es necesaria para utilizarla con Harbour?

Cristobal Navarro

Hay dos tipos de personas: las que te hacen perder el tiempo y las que te hacen perder la noci贸n del tiempo

El secreto de la felicidad no est谩 en hacer lo que te gusta, sino en que te guste lo que haces
Posts: 728
Joined: Fri Oct 07, 2005 07:38 AM
Re: Documentador autom谩tico de c贸digo?
Posted: Wed Sep 23, 2020 06:25 AM
En Natural docs b谩sicamente hay que crear un nuevo lenguaje con ciertas directivas para que "entienda" los comentarios de harbour.
En mi caso me bast贸 con modificar languages.txt y a帽adir :
Code (fw): Select all Collapse
Language: Harbour
聽
聽 聽Extensions: prg inc ch c
聽 聽Shebang String: Harbour
聽 聽Line Comment: //
聽 聽Block Comment: /* */
聽 聽Member Operator: ::
聽 聽Case Sensitive: No


Aqu铆 un peque帽o prg con comentarios de ejemplo:
Code (fw): Select all Collapse
/* CLASS: TClasePruebas
聽 聽 Este es la descripci贸n de una clase que no hace nada
聽 聽 Ejemplo de uso : 
聽 聽 --- Code
聽 聽 Local oClas:=TClasePruebas():New()
聽 聽 oClas:Activate(.T.)
聽 聽 oClas:End()
聽 聽 ---

*/

#include "fivewin.ch"

CLASS TClasePruebas FROM TWindow
聽 聽 METHOD New() CONSTRUCTOR
聽 聽 METHOD Activate(lNow)
聽 聽 METHOD End()
END CLASS

// Group: EXPORTED METHODS
/* FUNCTION: New()
聽 聽 Inicia la clase*/
METHOD New() CLASS TClasePruebas
Return (nil)

/* FUNCTION: Activate(lNow)
聽 聽 Activa la clase

Par谩metros:

聽 聽lNow - Activa la clase inmediatamente

Devuelve:

聽 聽nil

*/

METHOD Activate(lNow)
Return (nil)

// Group: PROTECTED METHODS

/* FUNCTION: End()
聽 聽 Destruye el objeto

*/
METHOD End() CLASS TClasePruebas
Return (nil)

// Group: OTROS Datos

/*
Database Column: MyColumn

聽 聽 --- Prototype ---
聽 聽 TopicID INTEGER PRIMARY KEY NOT NULL
聽 聽 -----------------

聽 聽 Description of MyColumn
*/
Angel Salom
Visionwin Software - https://www.visionwin.com
------------------------------------------------------------
fwh 19.05 - harbour 3.2 - bcc 7.4

Continue the discussion