Является ли галерея аннотаций Google полезной в производственном коде?
Я действительно мог бы увидеть использование Галерея аннотаций 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);
}
Это серьезный вопрос. Может ли это использоваться в реальном обзоре кода?
Ответы
Ответ 1
Довольно. Ну, не все из них, но многие могут заменить более длинные комментарии.
Это верно для не слишком многих из этих аннотаций, но некоторые (как в вашем примере) могут быть удобными.
Можно сказать, что эти аннотации представляют наиболее распространенные комментарии короче и, возможно, более читабельны.
Затем вы можете обработать их и добавить трески для, скажем, количества аннотаций @Magic
. Если проект становится слишком "волшебным", следует принять меры.
Ответ 2
Было бы проще использовать комментарии с таким ключом, как "MAGIC", а затем работать с ними. Hudson и Eclipse и другие инструменты могут считать или отмечать эти вхождения.
Ответ 3
Я могу определенно увидеть, как @CarbonFootprint
будет вписываться в несколько политик CSR клиента, а аннотация @WTF("comment")
будет очень удобной, когда вы будете работать над новым проектом, где вы не уверены, будет ли определенная часть код действительно необходим, чтобы обойти некоторые сумасшедшие ошибки/угловые условия или если это просто случайный, левый дерьмо, что никто не знал, как писать лучше в то время.
Ответ 4
FYI, похоже, Sonar теперь включает улучшенный плагин версии.
В любом случае, если бы вы не догадались, я думаю, что короткое название проекта достаточно ясно говорит о намерениях этого проекта: gag аннотации для того, что они могут стать, когда они оставлены свободными: эквивалент ах-а-й-а-а-а-а-а./p >
Ответ 5
Я предполагаю, что некоторые люди, возможно, пропустили аббревиатуру и дату этой Галереи аннотаций Google (GAG) 1 апреля... или, может быть, в некоторых странах это не национальный день для шуток или приколов...