O que as pessoas geralmente querem dizer quando você vê XXX em um comentário. Ocasionalmente, vejo um comentário como este:
# XXX - This widget really should frobulate the whatsit
Claro, posso dizer o que o comentário significa, mas o que o XXX geralmente significa? Está dizendo "Isto é um hack" ou talvez "Talvez devêssemos revisitar isso mais tarde"? Ou está dizendo algo completamente diferente?
O que XXX representa depende do autor do código. Em geral, é usado como marcador para código que requer atenção.
No entanto, esta página da web indica uma linha de pensamento um pouco diferente:
XXX : used to flag something that is bogus but works
FIXME : used to flag something that is bogus and broken
Acho que isso mostra ainda que seu significado não é bem definido e é usado de maneira diferente.
Por Wikipedia : "XXX para avisar outros programadores de código problemático ou mal orientado." - que pode ser retirado de recipientes de veneno que dizem "xxx" neles; super escola antiga.
Se for uma nota de TODO, aqui está uma postagem relacionada no blog, TODO ou não TODO , que abrange usando o GREP para classificar os comentários por data, proprietário, etc.
Não significa nada. É apenas uma sequência de caracteres que é visualmente distinta (o que facilita a varredura visual) e é improvável que apareça no código ou nos comentários (o que facilita a busca por programação).
Portanto, ele é usado como marcador para sinalizar comentários que precisam ser pesquisados com facilidade. Normalmente, marca um pedaço de código que precisa ser revisitado.
IIRC é uma anotação que antecede e tem um significado semelhante para as anotações TODO ou FIXME. É bastante comum na fonte do vim, por exemplo.
É mais provável que seja uma sequência de caracteres que não ocorre em código normal, o que significa que é facilmente pesquisável a partir de uma linha de comando:
ravn:tmp ravn$ echo XXXX This is very bad > processor.c
ravn:tmp ravn$ echo XXXX Verify defaults before going in production > main.c
ravn:tmp ravn$ grep -R XXXX .
./main.c:XXXX Verify defaults before going in production
./processor.c:XXXX This is very bad
ravn:tmp ravn$
(exemplo é para Unix, acredito que "findstr" faz o mesmo no Microsoft Windows)
but what does the XXX generally mean? Is it saying "This is a hack" or maybe "Perhaps we should revisit this later"? Or is it saying something else entirely?
Qualquer uma das opções acima.
A escolha de XXX versus TODO ou FIXME ou HACK ou qualquer outra coisa não é governada por nenhuma regra ou convenção strong. Basicamente, significa o que quer que a pessoa que o colocou ali pretendesse significar. Pode ser óbvio ... ou pode ser totalmente obscuro para você.
ATUALIZAÇÃO Wikipedia atualmente (2016-03-30) diz:
Such tags differ widely, but might include:
- ...
- XXX - warn other programmers of problematic or misguiding code
Observe as advertências claras no texto original. O XXX pode ser interpretado como uma alusão ao "XXX" que você vê em garrafas de veneno e / ou bebidas alcoólicas em quadrinhos clássicos, desenhos animados, etc.
É mais provavelmente um marcador que pode ser encontrado mais tarde. Ao contrário de TODO ou FIXME ou iguais, XXX é muito raramente encontrada em qualquer palavra ou construir, portanto, tornando-o perfeito para um marcador que vai ficar sozinho quando os arquivos estão sendo pesquisados através de.
De onde eu sou originalmente usamos XXX (e depois YYY, ZZZ) para números que ainda não os conhecemos, por exemplo: adicione XXX a YYY para encontrar o resultado e adicione 10%.
Origina-se de equações na escola onde 'x' é a variável desconhecida.
Tags coding-standards comments