Sie sind auf Seite 1von 2

As marcações aceitas pelo ProtheusDOC até o momento são:

Marcação Parâmetros Múltiplos Descrição da marcação

@accessLevel accessLevel- Nível de acesso.


text

@author name-text Texto com o nome do autor.

@build build-text Indica qual a versão do servidor


requerido (similar a "@version").

@country country-text Indica para qual país o elemento foi


programado.

@database database-text Compatibilidade com base de dados.

@defvalue defvalue-text Indica o valor padrão da propriedade.

@description description- Cria uma entrada de descrição, para


text melhor detalhamento da funcionalidade.

@deprecated deprecated- Texto com comentários sobre a


text depreciação, como por exemplo, motivo
e alternativa que deve ser utilizada.

@example example-text Sim Cria uma entrada no tópico “Exemplos”.

@history date-text, Sim Histórico de alterações no código-fonte.


(TDS11.3) username-
text,
description-
text

@sample example-text Sim O mesmo que "@example".

@language language-text Idioma para o qual elemento está


customizado.

@link link-text Sim Cria uma ligação (link) para o target


especificado (ver notas). O atributo label
será apresentado ao desenvolvedor no
lugar da URI e é opcional. Esta marcação
deve ser utilizada como complemento
nas demais marcações.

@obs obs-text Sim Adiciona uma observação.

@param parameter- Sim Adiciona uma especificação de


name parâmetro (de função ou método),
[ , parameter- identificando-o como parameter-name.
type]
Marcação Parâmetros Múltiplos Descrição da marcação

[ , description
]

@proptype proptype-text Indica o tipo da propriedade.

@protected Indica que o método deve ser visto com


escopo de “não publico”.

@readonly Indica que a propriedade é apenas de


leitura.

@return return-type Especifica o retorno (de função ou


description método).

@source source-text Indica o código fonte.

@systemOper systemOper- Indica qual o Sistema Operacional


text requerido.

@see see-text Sim Adiciona uma entrada “Veja também”.

@since since-text Identifica a partir de quando, uma


determinada funcionalidade foi
implementada.

@table table-name Identifica quais tabelas são utilizadas


[ , another- pela classe, método ou função.
table-name ]*

@todo todo-text Sim Identifica uma tarefa a ser realizada.

@type type-text Identifica o tipo do ProtheusDoc que está


sendo documentado:
• "function" para Funções
• "class" para Classes
• "method" para Métodos
• "property" para Propriedades de
classes
• "variable" para Variáveis

@version version-text Indica para qual versão de produto ou


mesmo servidor, que uma determinada
funcionalidade requer.

Fonte original: https://tdn.totvs.com/display/tec/ProtheusDOC

Das könnte Ihnen auch gefallen