Skip to content

Instantly share code, notes, and snippets.

@wescleymatos
Created January 5, 2012 17:30
Show Gist options
  • Save wescleymatos/1566267 to your computer and use it in GitHub Desktop.
Save wescleymatos/1566267 to your computer and use it in GitHub Desktop.
List de anotations do PHPDoc
@access - controle de acesso para um elemento. Se for definido como private o elemento não constará na documentação
@author - utilizado para indicar o autor de qualquer elemento que possa ser documentado (variáveis globais, funções, classes, métodos, etc.). Nesta tag pode-se adicionar o e-mail entre os sinais de < e >
@category - especifica a categoria para organizar os pacotes dos elementos documentados
@copyright - informações de copyright do elemento.
@deprecated - indica que o elemento está depreciado, sendo assim não deve ser utilizado por pode ser removido posteriormente
@example - inclui um arquivo externo de exemplo com sintaxe destacada
@final - indica que um método de uma classe nunca deve ser sobrescrito em uma classe filha
@filesource - cria a referência cruzada para o arquivo que contem o código fonte
@global - documenta uma variável global. Também é utilizado para métodos/funções
@ignore - previne o elemento de ser documentado, normalmente utilizado para elementos duplicados
@internal - define a documentação como privada, ou seja interna ao projeto
@licence - exibe o link para a url que referencia a licença de uso
@link - exibe um link na documentação
@package - define um pacote para agrupar as classes ou funções
@param - documenta um parâmetro da função
@return - documenta o retorno de uma função
@see - exibe um link para a documentação de um elemento
@since - indica desde qual versão o elemento foi adicionado ao projeto
@static - documenta uma variável ou método estático
@todo - indica as mudanças que serão realizadas no futuro
@version - indica a versão do elemento
inline {@internal}
inline {@inheritdoc}
inline {@link}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment