Cosa significa XXX in un commento? [chiuso]


72

Cosa significano generalmente le persone ogni volta che vedi XXXin un commento. Occasionalmente, vedrò un commento come questo:

# XXX - This widget really should frobulate the whatsit

Certo, posso dire cosa significa il commento, ma cosa significa generalmente XXX? Sta dicendo "Questo è un trucco" o forse "Forse dovremmo rivederlo più tardi"? O sta dicendo qualcos'altro interamente?



Io uso qazpersonalmente. Facile da scrivere e in 40 anni di programmazione non è mai stato naturale nel mio codice, quindi posso facilmente cercarlo. Invece di FixMe: o ToDo: lo uso per rapidi hack sperimentali che posso facilmente invertire se non funzionano. Ma il mio nonqaz sarebbe mai impegnato nel controllo del codice sorgente, mentre FixMe: o ToDo: o XXX potrebbero esserlo.
Mawg,

Ho notato che ci sono molti vecchi commenti XXX nella base di codice di Meteor ... una specie di commento continuo sui suoi sporchi segreti. E sembra che usano alcuni strumenti per rimuoverli automaticamente dal codice che viene spedito!
Andy,

Risposte:


68

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

Tuttavia, questa pagina web afferma un treno di pensiero leggermente diverso:

XXX: usato per contrassegnare qualcosa che è falso ma funziona

FIXME: usato per contrassegnare qualcosa di falso e rotto

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


12
HACKsarebbe un'alternativa a XXX.
Richard,

1
il collegamento è interrotto :(
Jack

1
FIXME: link broken
onewhaleid

1
HACK non è un'alternativa a XXX. Il flag di commento XXX ha una lunga storia e essenzialmente significa qualcosa che funziona, ma ha bisogno di attenzione (fasullo ma funziona).
Brill Pappin,

98

È un pezzo di codice sporco ;)


20
È una risposta divertente o una risposta divertente e corretta?
Koenmetsu,

4
oh quei programmatori birichini
codice aereo

@koenmetsu divertente e preciso. È sbagliato , ma per ora funziona abbastanza bene, quindi non del tutto sbagliato. "Sporco" è una descrizione adatta per qualcosa che funziona ma non è del tutto corretto (cioè pulito).
Iiridayn

21

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

Se è una nota TODO, ecco un post di blog correlato chiamato TODO o non TODO , che copre l'utilizzo di GREP per ordinare i commenti per data, proprietario, ecc.


13

Non significa niente. È solo una sequenza di caratteri visivamente distintivi (che facilita la scansione visiva) e che è improbabile che compaiano in codice o commenti (il che rende facile la ricerca programmatica).

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


2
Anche facile da trovare con grep o simili
Zachary K

7

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


6

È 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$ 

(esempio per Unix, credo che "findstr" faccia lo stesso con Microsoft Windows)


4

ma cosa significa generalmente XXX? Sta dicendo "Questo è un trucco" o forse "Forse dovremmo rivederlo più tardi"? O sta dicendo qualcos'altro interamente?

Qualsiasi dei precedenti.

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


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

Tali tag differiscono ampiamente, ma potrebbero includere:

  • ...
  • XXX - avvisa altri programmatori di codice problematico o fuorviante

Nota le chiare avvertenze nel testo originale. La XXX potrebbe essere interpretata come un'allusione alla "XXX" che vedi su bottiglie di veleno e / o chiaro di luna in fumetti classici, cartoni animati, ecc.


2

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


0

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

Proviene da equazioni a scuola dove "x" è la variabile sconosciuta.

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.