METHOD GET COMMENTS

4D v19

METHOD GET COMMENTS


METHOD GET COMMENTS ( rota ; comentários {; *} )

Parâmetro	Tipo	Descrição
rota	Texto, Array texto	Texto ou array de texto que contém uma ou várias rotas de método
comentários	Texto, Array texto	Comentários dos métodos designados
*	Operador	Se passado = o comando se aplica à base local quando se executa desde um componente (parâmetro ignorado fora deste contexto)

Descrição

O comando METHOD GET COMMENTS devolve no parâmetro comentários, os comentários dos métodos designados pelo parâmetro rota.

A documentação recuperada por este comando é a especificada no Explorador de 4D (não devem confundir-se com as linhas de comentarias no código que se recuperam utilizando METHOD GET CODE):

Contém:

texto em markdown em banco de dados projeto
texto estilizado em bancos de dados binário

Esta documentação pode ser gerada para métodos de tipo triggers, métodos de projeto, métodos de formulário, métodos de banco de dados.

Nota: os formulários e os métodos formulário compartilham a mesma documentação.

Pode utilizar dois tipos de sintaxes, baseadas em arrays texto ou em variáveis texto:

 C_TEXT(tVpath) // variáveis texto

 C_TEXT(tVcomments)

 METHOD GET COMMENTS(tVpath;tVcomments) // documentação de um só método

 ARRAY TEXT(arrPaths;0) // arrays texto

 ARRAY TEXT(arrComments;0)

 METHOD GET COMMENTS(arrPaths;arrComments) // documentação de vários métodos

Não podem combinar-se as duas sintaxes.

Se o comando é executado desde um componente, se aplica por defeito aos métodos do componente. Se passado o parâmetro *, é acessado aos métodos da base local.

Ver também

METHOD SET COMMENTS