2010-04-01 7 views
12

pude ver realmente un uso para el Google Annotations Gallery en código real:¿La Galería de comentarios de Google es útil en el código de producción?

tropezar a través de código que funciona de alguna manera allá de toda razón? La vida es corta. Marcos con @Magic y seguir adelante:

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

Esta es una pregunta seria. ¿Podría esto ser utilizado en una revisión de código real?

+1

¿Por qué los comentarios no son lo suficientemente buenos para esto? –

+0

Acabo de publicar una sugerencia que creo que sería útil en algunos equipos en los que he trabajado .... http://groups.google.com/group/google-annotations-gallery/browse_thread/thread/f41510434cc520e6 – Cowan

Respuesta

8

Bastante. Bueno, no todos, pero muchos podrían ser sustitutos de comentarios más largos. Eso es cierto para no demasiadas de estas anotaciones, pero algunas (como en su ejemplo) podrían ser útiles.

Se puede decir que estas anotaciones presentan los comentarios más comunes de una manera más corta y quizás más legible.

Puede procesarlos más adelante y agregar umbrales para, por ejemplo, el número de anotaciones @Magic. Si un proyecto se vuelve demasiado "mágico", se deben tomar medidas.

0

FYI, Sonar parece ahora incluir un better revision plugin.

De todos modos, si no adivinaras, creo que el nombre corto del proyecto es lo suficientemente claro sobre las intenciones de este proyecto: amordazar las anotaciones por lo que pueden ser cuando se dejan libres: un equivalente al infierno XML de oh-so-y2k.

1

Sería más fácil usar comentarios con una clave como "MAGIC", y luego trabajar con ellos. Hudson y Eclipse y otras herramientas pueden contar o marcar esas ocurrencias.

1

definitivamente puedo ver cómo el @CarbonFootprint puedan integrarse en las políticas de RSC varios de los clientes, y la anotación @WTF("comment") sería muy útil cuando se está trabajando en un nuevo proyecto en el que no está seguro de si una determinada pieza de código que realmente es necesitaba solucionar una situación de error/esquina loca o si simplemente era basura aleatoria, al azar, que nadie sabía cómo escribir mejor en ese momento.

0

Supongo que algunas personas pueden haber perdido el acrónimo y la fecha de esa galería de anotaciones de Google (GAG) el 1 de abril ... o tal vez en algunos países no es un día nacional para chistes o gags ...

Cuestiones relacionadas