Полезна ли Галерея аннотаций Google в рабочем коде?

Question

Я действительно мог видеть использование Галерея аннотаций Google в реальном коде:

Наткнуться на код, который как-то работает вне всякой причины? Жизнь коротка. отметка это с @Magic и двигаться дальше:

@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);
}

Это серьезный вопрос. Может ли это быть использовано в реальном обзоре кода?

Answer 1

Довольно. Ну, не все из них, но многие могут заменить более длинные комментарии. Это верно не для многих из этих аннотаций, но некоторые (как в вашем примере) могут быть полезны.

Можно сказать, что эти аннотации представляют наиболее распространенные комментарии в более короткой и, возможно, более читаемой форме.

Вы можете позже обработать их и добавить пороговые значения, скажем, для количества @Magic аннотаций. Если проект становится слишком «волшебным», следует принять меры.

Answer 2

Я определенно вижу, как @CarbonFootprint вписывается в несколько политик CSR клиента, и аннотация @WTF("comment") будет очень полезна, когда вы работаете над новым проектом, в котором вы не уверены, является ли определенный фрагмент код на самом деле нужен для того, чтобы обойти какую-то сумасшедшую баг / угловую ситуацию или, если это просто случайная, оставшаяся ерунда, которую никто не знал, как писать лучше в то время.

Answer 3

Было бы проще использовать комментарии с ключом, таким как «MAGIC», а затем работать с ними. Hudson, Eclipse и другие инструменты могут подсчитывать или отмечать эти случаи.

Answer 4

Полагаю, некоторые люди пропустили аббревиатуру и дату галереи аннотаций Google (GAG) 1 апреля ... или, может быть, в некоторых странах это не национальный день для шуток или приколов ...

Answer 5

К вашему сведению, Sonar теперь включает в себя улучшенный плагин ревизии .

Во всяком случае, если бы вы не догадались, я думаю, что краткое название проекта достаточно ясно о намерениях этого проекта: кляп аннотации для того, что они могут стать, если оставить свободными: эквивалент XML-ад oh-so-y2k. 1005 *