Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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

MarcaçãoParâmetrosMúltiplosDescrição da marcação

@accessLevel

accessLevel-text Nível de acesso.
@authorname-text 

Texto com o nome do autor.

@buildbuild-text Indica qual a versão do servidor requerido (similar a "@version").
@countrycountry-text Indica para qual país o elemento foi programado.
@databasedatabase-text Compatibilidade com base de dados.
@descriptiondescription-text Cria uma entrada de descrição, para melhor detalhamento da funcionalidade.
@deprecated

deprecated-text

 

Texto com comentários sobre a depreciação, como por exemplo, motivo e alternativa que deve ser utilizada.

@exampleexample-text SimCria uma entrada no tópico “Exemplos”.
@sampleexample-text SimO mesmo que "@example". 
@languagelanguage-text Idioma para o qual elemento está customizado.
@linklink-text SimCria 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.
@obsobs-text SimAdiciona uma observação.
@paramparameter-name parameter-type descriptionSimAdiciona uma especificação de parâmetro (de função ou método), identificando-o como parameter-name. 
@protected  Indica que o método deve ser visto com escopo de “não publico”.
@returnreturn-type description Especifica o retorno (de função ou método).
@systemOpersystemOper-text Indica qual o Sistema Operacional requerido.
@seesee-textSimAdiciona uma entrada “Veja também”.
@sincesince-text Identifica a partir de quando, uma determinada funcionalidade foi implementada.
@tabletable-name [ , another-table-name ]* Identifica quais tabelas são utilizadas pela classe, método ou função.
@todotodo-text Identifica uma tarefa a ser realizada.
@versionversion-text Indica para qual versão de produto ou mesmo servidor, que uma determinada funcionalidade requer.

...