Faça comentários com Codetags

Patrick Porto
Aug 23, 2017 · 2 min read

Codetags é um recurso suportado pela maioria das IDEs e editores de código. Ele permitem rastrear parte de códigos utilizando tokens nos comentários. Este é um recurso não-padronizado pelas ferramentas, então segue os tokens mais comuns que podem ser encontrados na maioria delas:

  • TODO: Faz parte do padrão de quase todas as ferramentas que existe. Ele significa que a funcionalidade ainda não foi implementada.
  • FIXME: Informa que o código precisa ser refatorado para corrigir algum problema ou melhorar a legibilidade.
  • XXX: Informa sobre algum detalhe relevante do código implementado.
  • NOTE: Informa sobre alguma parte do funcionamento do código que está implícita.
  • HACK: Informa que o código está mal escrito para tentar contornar algum bug ou para atender uma necessidade temporariamente.
  • BUG: Informa que o código está com algum erro conhecido que precisa ser corrigido
  • NOFIX: Informa que o código possui problemas conhecidos mas que não serão abordados por problemas de design ou limitações.
  • ???: Informa que existe algum detalhe que não está sendo compreendido no funcionamento do código.

Existe a possibilidade de utilizar codetags para gerenciar seu board de tarefas através de plugins, como o imdome para atom.

Conforme já ressaltado anteriormente, codetags não são padronizados, por mais que já tenha ocorrido tentativas. Caso exista a necessidade de ter mais tokens então não evite criá-los.

Referências

)

Patrick Porto

Written by

Software Developer at Globo.com.

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade