Política de obsolescência de métodos

De Wiki Expresso V3
Ir para: navegação, pesquisa

Ao se obsolescer métodos, é obrigatório que se execute os seguintes passos:

  1. Colocar o atributo @deprecated no comentário do método em 3 linhas diferentes, da seguinte forma e com as seguintes informações:
    1. caso exista um método substituto:
@deprecated use <Classe>::<Metodo>
@deprecated in Task <XXXXX>
@deprecated will be removed in Task <YYYYY>
  • Colocar na primeira linha do método obsoleto um warning logando que método deve ser utilizado no seu lugar. Por exemplo:
Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ':: Deprecated method. Use <Classe>::<Metodo> instead');
    1. caso não exista método substituto:
@deprecated Do not use it
@deprecated in Task <XXXXX>
@deprecated will be removed in Task <YYYYY>
  • Colocar na primeira linha do método obsoleto um warning logando que método deve ser utilizado no seu lugar. Por exemplo:
Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ':: Deprecated method. Do not use it');


  1. Criar a Task que removerá o método e as chamadas para o método obsoleto e referenciá-la no comentário do método obsoleto.
  2. Criar referências entre das Tasks.

OBS: Caso uma task tornar mais de um método obsoleto, deverá ser criada uma task por método obsoleto para limpeza do código.

Ferramentas pessoais
Espaços nominais

Variantes
Ações
Navegação
Ferramentas