O que XXX significa em um comentário? [fechadas]


72

O que as pessoas geralmente querem dizer sempre que você vê XXXum 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 "Isso é um hack" ou talvez "Talvez devêssemos revisitar isso mais tarde"? Ou está dizendo algo completamente diferente?



Eu uso qazpessoalmente. Fácil de digitar e em 40 anos de codificação nunca ocorreu naturalmente no meu código, para que eu possa pesquisá-lo facilmente. Em vez de FixMe: ou ToDo: eu o uso para hacks experimentais rápidos que podem ser revertidos facilmente se não derem certo. Mas a minha qazseria não estar comprometido com controle de origem, enquanto FixMe: ou Fazer: ou XXX poderia ser.
MAWG

Percebi que há muitos comentários antigos sobre o XXX na base de código do Meteor ... um tipo de comentário sobre seus segredos sujos. E parece que eles usam alguma ferramenta para removê-los automaticamente do código que é enviado!
Andy

Respostas:


68

O que XXXrepresenta, depende do autor do código. Em geral, é usado como marcador de código que requer atenção.

No entanto, esta página da web indica uma linha de pensamento um pouco diferente:

XXX: usado para sinalizar algo que é falso, mas funciona

FIXME: usado para sinalizar algo que é falso e quebrado

Acho que isso mostra ainda mais que seu significado não está bem definido e é usado de maneira diferente.


12
HACKseria uma alternativa para XXX.
Richard

11
ligação é interrompida :(
Jack

11
FIXME: link broken
Onewhaleid

11
O HACK não é uma alternativa ao XXX. O sinalizador de comentário do XXX tem uma longa história e significa essencialmente algo que funciona, mas precisa de atenção (falso, mas funciona).
Brill Pappin

98

É um pedaço de código sujo ;)


20
Esta é uma resposta engraçada ou uma resposta engraçada e correta?
28913 koenmetsu

4
oh os programadores impertinentes
aeracode

@koenmetsu engraçado e preciso. Está errado , mas funciona bem o suficiente por enquanto, portanto, não está totalmente errado. "Sujo" é uma descrição apropriada para algo que funciona, mas não é totalmente correto (ou seja, limpo).
Iiridayn 6/03

21

De acordo com a Wikipedia : "XXX para avisar outros programadores de código problemático ou equivocado". - que pode ser retirado de recipientes de veneno que dizem "xxx" neles; super velha escola.

Se for uma nota do TODO, aqui está uma postagem de blog relacionada chamada TODO ou não TODO , que aborda o uso do GREP para classificar comentários por data, proprietário etc.


13

Não significa nada. É apenas uma sequência de caracteres visualmente distintos (o que facilita a verificação visual) e é improvável que apareça no código ou nos comentários (o que facilita a pesquisa por programação).

Portanto, é usado como um marcador para sinalizar comentários que precisam ser facilmente pesquisáveis. Normalmente, ele marca um pedaço de código que precisa ser revisado.


2
Também fácil de encontrar com grep ou similar
Zachary K

7

IIRC é uma anotação que antecede e tem um significado semelhante às anotações TODO ou FIXME. É bastante comum na fonte do vim, por exemplo.


6

Provavelmente, é uma sequência de caracteres que não ocorre no código regular, o que significa que é facilmente pesquisável em 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" faça o mesmo no Microsoft Windows)


4

mas o que geralmente significa o XXX? Está dizendo "Isso é um hack" ou talvez "Talvez devêssemos revisitar isso mais tarde"? Ou está dizendo algo completamente diferente?

Qualquer uma das anteriores.

A escolha de XXX versus TODO ou FIXME ou HACK ou qualquer outra coisa não é governada por regras ou convenções fortes. Basicamente, significa o que a pessoa que o colocou lá pretendeu que isso significasse. Pode ser óbvio ... ou pode ser totalmente opaco para você.


ATUALIZAÇÃO Wikipedia atualmente (30-03-2016) diz:

Essas tags diferem amplamente, mas podem incluir:

  • ...
  • XXX - avise outros programadores sobre código problemático ou equivocado

Observe as ressalvas claras no texto original. O XXX pode ser interpretado como uma alusão ao "XXX" que você vê em garrafas de veneno e / ou luar em quadrinhos clássicos, desenhos animados etc.


2

Provavelmente é um marcador que pode ser encontrado mais tarde. Diferentemente de TODO, FIXME ou similares, o XXX raramente é encontrado em qualquer palavra ou construção, tornando-o perfeito para um marcador que permanecerá sozinho quando os arquivos estiverem sendo pesquisados.


0

De onde eu sou originalmente, usamos XXX (e depois AAAA, ZZZ) para números que ainda não os conhecemos, por exemplo: adicione XXX a AAAA para encontrar o resultado e, em seguida, adicione 10%.

Origina-se de equações na escola onde 'x' é a variável desconhecida.

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.