METHOD SET COMMENTS

4D v20 R7

METHOD SET COMMENTS


METHOD SET COMMENTS ( ruta ; comentarios {; Operador} )

Parámetro	Tipo	Descripción
ruta	Texto, Array texto	Texto o array texto que contiene una o varias rutas de métodos
comentarios	Texto, Array texto	Comentarios de los métodos designados
Operador	Operador	Si se pasa = el comando se aplica a la base local cuando se ejecuta desde un componente (parámetro ignorado fuera de este contexto)

Descripción

El comando METHOD SET COMMENTS remplaza la documentación del(os) método(s) designados por el parámetro ruta por los definidos en el parámetro comentarios.

La documentación modificada por este comando se muestra en el explorador de 4D (no debe confundirse con líneas de comentarios en el código). Contiene:

texto markdown en bases proyecto,
texto con estilo en bases binarias.

Esta documentación se puede generar para métodos de tipo triggers, métodos proyecto, métodos formulario, métodos base y clases.

Nota: los formularios y los métodos formulario comparten la misma documentación.

Puede utilizar dos tipos de sintaxis, basadas en arrays texto o variables texto:

 C_TEXT(tVpath) // variables texto

 C_TEXT(tVcomments)

 METHOD SET COMMENTS(tVpath;tVcomments) // documentación para un sólo método

 ARRAY TEXT(arrPaths;0) // arrays texto

 ARRAY TEXT(arrComments;0)

 METHOD SET COMMENTS(arrPaths;arrComments) // documentación para varios métodos

No es posible combinar las dos sintaxis.

Si pasa un nombre de ruta invalido, se genera un error.

Puede ejecutar este comando desde un componente, pero en este caso debe pasar el parámetro * porque el acceso en modo escritura al código del componente no es posible. Si omite el parámetro * en este contexto, se genera el error -9763.

Ejemplo

Añadir una fecha de modificación a un comentario de trigger existente:

 METHOD GET COMMENTS("[trigger]/Table1";$comments)

 $comments:="Modif:"+String(Current date)+"\r"+$comments

 METHOD SET COMMENTS("[trigger]/Table1";$comments)

Ver también

METHOD GET COMMENTS