METHOD SET COMMENTS
METHOD SET COMMENTS ( rota ; Comentarios {; *} )
| Parâmetro | Tipo | Descrição | |
|---|---|---|---|
| rota | Text, Text array | → | Texto ou array texto contendo uma ou mais rotas de método |
| Comentarios | Text, Text array | → | Comentários dos métodos designados |
| * | Operador | → | Se passado = o comando aplica ao banco de dados local quando é executado de um componente (parâmetro ignorado fora deste contexto) |
Esse comando não é seguro para thread e não pode ser usado em código adequado.
Descrição
O comando METHOD SET COMMENTS substitui os comentários dos métodos designados pelo parâmtero rota pelos definidos no parâmetro comentarios.
A documentação modificada por este comando é mostrada no explorador de 4D (não deve ser confundida com linhas de comentários no código). Contém:
- texto markdown em bancos de dados projeto,
- texto com estilo em bancos de dados binários.
Esta documentação pode ser gerada para métodos de tipo triggers, métodos de projeto, métodos de formulário ou métodos de banco de dados.
Nota: os formulários e os métodos formulário compartem a mesma documentação.
Pode usar dois tipos de sintaxe, baseadas em arrays texto ou variáveis texto:
var tVpath : Text // variáveis texto
var tVcomments : Text
METHOD SET COMMENTS(tVpath;tVcomments) // documentação de um só método
ARRAY TEXT(arrPaths;0) // arrays texto
ARRAY TEXT(arrComments;0)
METHOD SET COMMENTS(arrPaths;arrComments) // documentação para vários métodos
Não é possível combinar as duas sintaxes.
Se passar um nome de rota não válido, é gerado um erro.
Pode executar o comando de uma componente, mas neste caso você deve passar o parâmetro * porque o acesso ao código do componente é somente leitura. Se omitir o parâmetro * neste contexto, o erro -9763 é gerado.
Exemplo
Adicione uma data de modificação para um comentário de trigger existente:
METHOD GET COMMENTS("[trigger]/Table1";$comments)
$comments:="Modif:"+String(Current date)+"\r"+$comments
METHOD SET COMMENTS("[trigger]/Table1";$comments)