Che cosa significa XXX in un commento? [chiuso]

64

Che cosa significano le persone in genere ogni volta che vedi XXX in un commento. Occasionalmente, vedrò un commento come questo:

# XXX - This widget really should frobulate the whatsit

Naturalmente, posso dire cosa significa il commento, ma cosa significa in genere il XXX? Sta dicendo "Questo è un hack" o forse "Forse dovremmo rivisitare questo più tardi"? O sta dicendo qualcos'altro interamente?

    
posta Jason Baker 06.04.2011 - 01:51
fonte

9 risposte

63

Ciò che XXX rappresenta, dipende dall'autore del codice. In generale, viene utilizzato come marker per il codice che richiede attenzione.

Tuttavia, questa pagina web indica un modo di pensare un po 'diverso:

XXX : used to flag something that is bogus but works

FIXME : used to flag something that is bogus and broken

Immagino che ciò dimostri ulteriormente che il suo significato non è ben definito e viene usato in modo diverso.

    
risposta data 06.04.2011 - 02:09
fonte
91

È un pezzo di codice sporco ;)

    
risposta data 06.04.2011 - 02:23
fonte
19

Per Wikipedia : "XXX per avvertire altri programmatori di codice problematico o fuorviante." - che potrebbe essere estratto da contenitori di veleno che dicono "xxx" su di essi; super vecchia scuola.

Se si tratta di una nota TODO, ecco un post sul blog relativo chiamato TODO o non TODO , che copre utilizzando GREP per ordinare i commenti per data, proprietario, ecc.

    
risposta data 06.04.2011 - 03:34
fonte
12

Significa niente. È solo una sequenza di caratteri visivamente distintivi (che rende facile la scansione visiva) e che difficilmente appaiono in codice o commenti (il che rende facile la ricerca programmatica).

Quindi, viene utilizzato come marker per contrassegnare i commenti che devono essere facilmente ricercabili. Di solito, segna un pezzo di codice che deve essere rivisitato.

    
risposta data 06.04.2011 - 03:01
fonte
7

IIRC è un'annotazione che precede e ha un significato simile alle annotazioni TODO o FIXME. Ad esempio, è abbastanza comune nella fonte di vim.

    
risposta data 06.04.2011 - 01:52
fonte
5

Molto probabilmente è una sequenza di caratteri che non si verifica nel codice normale, il che significa che è facilmente ricercabile da una riga di 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$ 

(l'esempio è per Unix, credo che "findstr" faccia lo stesso in Microsoft Windows)

    
risposta data 06.04.2011 - 04:55
fonte
2

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?

Qualsiasi dei precedenti.

La scelta di XXX contro TODO o FIXME o HACK o qualcos'altro non è governata da regole o convenzioni forti. Fondamentalmente, significa qualunque cosa la persona che lo ha messo lì voleva dire che significava. Potrebbe essere ovvio ... o potrebbe essere totalmente opaco per te.

UPDATE Wikipedia attualmente (30-03-2016) dice:

Such tags differ widely, but might include:

  • ...
  • XXX - warn other programmers of problematic or misguiding code

Nota i caveat chiari nel testo originale. Il XXX potrebbe essere interpretato come un'allusione al "XXX" che vedi su veleno e / o bottiglie di vetro chiaro nei classici fumetti, cartoni animati, ecc.

    
risposta data 06.04.2011 - 05:22
fonte
1

Probabilmente è un marker che può essere successivamente trovato. A differenza di TODO, FIXME o simili, XXX si trova molto raramente in qualsiasi parola o costrutto, rendendolo quindi perfetto per un marcatore che starà da solo quando i file vengono cercati.

    
risposta data 06.04.2011 - 05:36
fonte
0

Da dove provengo originariamente usiamo XXX (e poi YYY, ZZZ) per i numeri che ancora non conosciamo, ad esempio: aggiungi XXX a YYY per trovare il risultato, quindi aggiungi il 10%.

Originato da equazioni a scuola dove 'x' è la variabile sconosciuta.

    
risposta data 06.04.2011 - 10:31
fonte

Leggi altre domande sui tag