9 respuestas en este tema

[Delphius]

Hola a todos,
Técnicamente no es un programa utilitario, pero me parece el lugar más apropiado para dejarles mis plantillas o macro para documentación que yo utilizo. Esta diseñada para el experto GExpert, aunque con unos cuantos cambios bien que se la puede portar a la de CnPack.

La posición puede ser de tipo Línea o Cursor. La de tipo línea quiere decir que la documentación se colorará justo al comienzo del renglón en donde esté el cursor actualmente. Por su parte, la del tipo Cursor indica que se generará justamente donde esté el cursor.
Hay un tercer tipo de posición que le permite colocarse al principio del archivo pero yo no la utilizo.

Unidades

delphi

{-------------------------------------------------------------------------------
 Unidad: %UNIT%
 Directorio: %UNITDIR%
 Fecha: %DATETIME%
 Autor: (%PROGRAMMERINITIALS%) %PROGRAMMERNAME%
 Versión: 0.<M.n.c>
 *******************************************************************************
 Descripción:
 |
 Véase: <LISTA-DOCS>
 Historial:
 <Version>:
   [+] <descripción-añadidos>
   [-] <descripción-eliminados>
   [=] <descripción-mejoras>
   [/] <descripción-planificados>
   [*] <descripción-defectos>
 ------------------------------------------------------------------------------}

Posición: Cursor

Clases:

delphi

{-------------------------------------------------------------------------------
 Clase: %CLASS%
 Fecha: %DATETIME%
 Versión: 0.<M.n.c>
 *******************************************************************************
 Descripción:
 |
 Véase: <LISTA-DOCS>
 ------------------------------------------------------------------------------}

Posición: Cursor, Antes de la clase

Interfaces:

delphi

{-------------------------------------------------------------------------------
 Interfaz: %INTERFACE%
 Fecha: %DATETIME%
 Versión: 0.<M.n.c>
 *******************************************************************************
 Descripción:
 |
 Véase: <LISTA-DOCS>
 ------------------------------------------------------------------------------}

Posición: Línea, antes de la inferface

Métodos:

delphi

%BEFORE%{---------------------------------------------------------------------------
 Método: %CLASS%.%METHODCLASS%
 Fecha: %DATETIME%
 Versión: 0.<M.n.c>
 ***************************************************************************
 Parámetros:%BEGINPARAMLIST%
 * %PARAMNAME%: %PARAMTYPE% = %PARAMDEF%  
   <Descripción-parámetro-%PARAMNAME%>%ENDPARAMLIST%
 Resultado: %RESULT%
 * <valor>: <descripción-resultado>
 Excepciones:
 * <Excepction>: <Descripción-excepción>
 Descripción:
 |
 Véase: <LISTA-DOCS>
 --------------------------------------------------------------------------}

Posición: Cursor, antes del método

Registros:

delphi

{-----------------------------------------------------------------------------
 Registro: %CLIPBOARD%
 Fecha: %DATETIME%
 Versión: 0.<M.n.c>
 *****************************************************************************
 Campos:
 * <campo>: <tipo>
   <Descripción-campo>
 Descripción:
 |
 Véase: <LISTA-DOCS>
 ----------------------------------------------------------------------------}

Posición: Cursor
NOTA: El nombre del registro debe haberse copiado previamente. La plantilla lee el contenido del portapapeles para armar la plantilla.

Enumerados:

delphi

{-----------------------------------------------------------------------------
 Enumerado: %CLIPBOARD%
 Fecha: %DATETIME%
 Versión: 0.<M.n.c>
 *****************************************************************************
 Valores:
 * <valor>: <descripción-valor>
 Descripción:
 |
 Véase: <LISTA-DOCS>
 ----------------------------------------------------------------------------}

Posición: Cursor
NOTA: Funciona igual que la plantilla para registros, lee la info desde el portapapeles.

Proyectos (.dpr)

delphi

{-------------------------------------------------------------------------------
 Proyecto: %PROJECTNAME%
 Fecha: %DATETIME%
 Versión: 0.<M.n.c>
 ===============================================================================
 Producto: %VERPRODUCTNAME%
 Nombre Interno: %VERINTERNALNAME%
 Descripción Projecto: %VERFILEDESCRIPTION%
 Versión Producto: %VERPRODUCTVERSION%
 Versión Archivo: %VERFILEVERSION%
 *******************************************************************************
 Descripción:
 |
 Véase: <LISTA-DOCS>
 ------------------------------------------------------------------------------}

Posición: Línea

Separadores:

delphi

// -------------------------------------------------------------------------- //
// %SELECTION%
// -------------------------------------------------------------------------- //

Posición: Línea

Fin Método:

delphi

%BEFORE%{* Fin M. %METHODCLASS% *}

Posición: Cursor

Espero que les sea de utilidad para ustedes.

Saludos,

[Desart]

Lo acabo de probar y funciona genial, muchas gracias Delphius 

[Rolphy Reyes]

Saludos.

Disculpen mi ignorancia, he utilizado el Source Template de CnPack pero no encuentro el GExperts.

¿Me podrían guiar?

[Delphius]

Hola Rolphy,
GExperts es otro experto. La página oficial es ésta.
Una vez que los tengas instalado ve a GExpert > GExpert Configuration.
En la solapa Editor Experts verás al experto Expand Macro Template (no recuerdo cual era el shortcut por defecto, yo lo alteré, por ello te indico por estos pasos). Selecciónalo y y luego presiona en Configure.
Allí ya podrás crear tus propias plantillas.

Saludos,

[egostar]

Hola

Yo no uso ni GExpert ni cnPack, pero me gusta documentar todo mi código, cambios, fechas, quien lo solicitó, quien lo hizo, motivo, etc....

Saludos

[Delphius]

Hola

Yo no uso ni GExpert ni cnPack, pero me gusta documentar todo mi código, cambios, fechas, quien lo solicitó, quien lo hizo, motivo, etc....

Saludos

Tengo entendido que las versiones 2006+ ya cuenta con plantillas para esto así que en este sentido GExperts y/o CnPack sobran.

Saludos,

[Rolphy Reyes]

Hola Rolphy,
GExperts es otro experto. La página oficial es ésta.
Una vez que los tengas instalado ve a GExpert > GExpert Configuration.
En la solapa Editor Experts verás al experto Expand Macro Template (no recuerdo cual era el shortcut por defecto, yo lo alteré, por ello te indico por estos pasos). Selecciónalo y y luego presiona en Configure.
Allí ya podrás crear tus propias plantillas.

Saludos,

Saludos.

@Delphius, no me exprese correctamente, si uso GExperts y CnPack, lo que desconocía era que GExperts podía generar templates como lo hace CnPack.

En la empresa usamos D2007, D2010 y DXE2, aún con los generadores nativos opto por los de CnPack y ahora incluiré a GExperts.

Gracias por el tip.

[Delphius]

Hola Rolphy,
GExperts es otro experto. La página oficial es ésta.
Una vez que los tengas instalado ve a GExpert > GExpert Configuration.
En la solapa Editor Experts verás al experto Expand Macro Template (no recuerdo cual era el shortcut por defecto, yo lo alteré, por ello te indico por estos pasos). Selecciónalo y y luego presiona en Configure.
Allí ya podrás crear tus propias plantillas.

Saludos,

Saludos.

@Delphius, no me exprese correctamente, si uso GExperts y CnPack, lo que desconocía era que GExperts podía generar templates como lo hace CnPack.

En la empresa usamos D2007, D2010 y DXE2, aún con los generadores nativos opto por los de CnPack y ahora incluiré a GExperts.

Gracias por el tip.

Ha, ya veo. Yo entendí mal. Pensé que cuando dijiste que no encontrabas GExperts te referías a que no lo veías entre las opciones de CnPack y que era del mismo "paquete". Mil disculpas.

Yo opté por el de GExperts porque tiene algo, al menos el de para D6, que no me ofrece CnPack (yo al menos no le encontré): el %BEFORE%. Esto permite que en lugar de que examine hacia adelante, lo haga hacia atrás.
Con CnPack no he logrado esto y me obliga a que la documentación preceda siempre a la declaración. ¿Tu sabrías decirme si se puede hacer eso con CnPack? Porqueyo no lo logré.
Y otra cosa que no le entendí es el uso de %ARGLIST% y el de %ARGUMENTS%.

Saludos,

[Rolphy Reyes]

Saludos.

No he usado la herramienta a plenitud en ese sentido como para poder explicarte, solo la he usado para agregar Initialization y Finalization a las unidades además de una breve descripción al inicio de la unidad.

Pero ya que estamos en eso, haré lo posible por sacar tiempo para realizar pruebas.

[ELKurgan]

Gracias por el aporte