Ist die Google Annotations Gallery im Produktionscode nützlich?

Question

Ich konnte tatsächlich eine Verwendung für die Google Annotations Gallery in echten Code sehen:

Stumble über Code, der irgendwie jenseits aller Vernunft funktioniert? Das Leben ist kurz. Mark es mit @Magic und weitermachen:

@Magic 
public static int negate(int n) { 
    return new Byte((byte) 0xFF).hashCode() 
    /(int) (short) '\uFFFF' * ~0 
     * Character.digit ('0', 0) * n 
     * (Integer.MAX_VALUE * 2 + 1) 
    /(Byte.MIN_VALUE >> 7) * (~1 | 1); 
} 

Dies ist eine ernste Frage. Könnte dies in einer tatsächlichen Code-Überprüfung verwendet werden?

Answer 1

Ziemlich. Nun, nicht alle, aber viele könnten Ersatz für längere Kommentare sein. Das gilt für nicht zu viele dieser Anmerkungen, aber einige (wie in Ihrem Beispiel) könnten nützlich sein.

Es kann gesagt werden, dass diese Anmerkungen die häufigsten Kommentare in einer kürzeren und vielleicht besser lesbaren Weise darstellen.

Sie können sie später bearbeiten und Schwellwerte für beispielsweise die Anzahl der @Magic Annotationen hinzufügen. Wenn ein Projekt zu "magisch" wird, sollten Maßnahmen ergriffen werden.

Answer 2

FYI, Sonar scheint jetzt eine better revision plugin zu enthalten.

Wie auch immer, sollten Sie nicht raten, ich denke, der kurze Projektname ist klar genug über die Absichten dieses Projekts: knebel die Annotationen für was sie werden können, wenn frei: ein Äquivalent zur oh-so-y2k XML-Hölle.

Answer 3

Es wäre einfacher, Kommentare mit einem Schlüssel wie "MAGIC" zu verwenden und dann mit diesen zu arbeiten. Hudson und Eclipse und andere Tools können diese Ereignisse zählen oder markieren.

Answer 4

Ich kann definitiv sehen, wie die @CarbonFootprint würde in mehrere CSR-Richtlinien des Kunden passen, und die @WTF("comment") Annotation wäre wirklich praktisch, wenn Sie an einem neuen Projekt arbeiten, wo Sie nicht sicher sind, ob ein bestimmtes Stück Code tatsächlich ist um einen verrückten Bug/eine Eckenbedingung zu bearbeiten oder wenn es nur zufälliger, linker Mist ist, dass niemand wusste, wie man zu der Zeit besser schreibt.

Answer 5

Ich vermute, einige Leute haben vielleicht das Akronym und das Datum der Google Annotation Gallery (GAG) am 1. April verpasst ... oder vielleicht ist es in einigen Ländern kein Nationalfeiertag für Witze oder Gags ...