Lo standard di commento $ FALL-THROUGH $ di Eclipse?

Question

Uso Eclipse, quindi il mio utilizzo dei commenti //$FALL-THROUGH$ è una pratica comune sulle istruzioni switch e simili. Ma il mio collega usa Netbeans e mi chiede cosa diavolo stavo facendo con questi. E provare a cercare qualcosa con un simbolo in google è come provare a tirare i denti con un paio di manopole congelate e senza strumenti ...

L'uso del commento //$FALL-THROUGH$, i segni del dollaro e tutto, una cosa java standard, o una sorta di magia di Eclipse? Se carico lo stesso codice in Netbeans o in un altro IDE, o lo eseguo attraverso il compilatore java autonomo, cadranno attraverso le istruzioni switch ancora contrassegnate con avvisi, anche con detto commento o no? Esiste un modo standard per fare ciò oltre all'utilizzo dell'annotazione @SupressWarning (che potrebbe semplicemente ingombrare il codice dato come lo si deve usare)?

Answer 1

Le cose come questa sono IDE/dipendente dallo stile di controllo. Non ci sono "commenti Java standard".

^{(Beh, Javadocs sono standard, ma non controllare la compilazione/segnalazione degli errori.)}

Una spiegazione del $FALL-THROUGH$ costrutto è menzionata in eclisse release documentation:

Il problema compilatore per i fall-through attesi nelle dichiarazioni caso-interruttore ora può essere soppresso precedendo la seguente dichiarazione del caso con un commento che inizia con $ FALL-THROUGH $. Questo è particolarmente interessante per il codice che non può utilizzare l'annotazione @SuppressWarnings ("fallthrough") in stile J2SE-5.0.

Si noti che i nomi di avviso per l'annotazione @Suppresswarnings dipendono dal compilatore e non sono uno standard di linguaggio Java.

Answer 2

Ho visto altri strumenti (ad esempio FindBugs) che utilizzano uno schema di commento simile. Ma nulla è standardizzato.

Nella maggior parte dei casi, questi avvisi vengono emessi solo quando l'istruzione case contiene il codice prima della caduta. Nella maggior parte dei casi, puoi evitarlo prendendo in considerazione il codice comune.

Per esempio, questo normalmente non innescare un avvertimento:

switch (foo) { 
    case 1: 
    case 2: 
    doSomething(); 
    break; 
    ... 
} 

ma questo sarebbe:

switch (foo) { 
    case 1: 
    doSomething(); 
    case 2: 
    doSomethingElse(); 
    break; 
    ... 
} 

Personalmente penso che gli avvertimenti sono lì per un motivo. Mi considero più leggibile (e sicuro) per il refactoring fuori codice comune e non hanno non vuoti fall-through:

switch (foo) { 
    case 1: 
    doSomething(); 
    doSomethingElse(); 
    break; 

    case 2: 
    doSomethingElse(); 
    break; 
    ... 
} 

Answer 3

Questo commento è IDE specifico e non può riuscire con le altre pedine IDE e di codice, anche se findbugs è intelligente abbastanza per controllare i commenti con la parola cadere in loro. Ma, in ogni caso, non dovresti fare affidamento sui commenti per fare qualcosa di più che dirigere il collega programmatore, stai solo creando un'altra cosa da mantenere.