WTF.java

WTF-complete.java

package dk.justaddwater.wtf

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by IntelliJ IDEA.
 * User: Jesper Rønn-Jensen
 * Date: 16/09/11
 * <p/>
 * None functional WTF annotation to amuse developers
 * <p/>
 * Usage: Annotate hard-to-understand code with the @WTF annotation
 * <p/>
 * <p>The <code>WTF</code> annotation supports two optional parameters.
 *
 * The first, <code>explain</code>, and write why you dont understand this annotated element
 *
 * The second, <code>explanation</code>, is to explain why and how the element should be used
 *
 * NOTE that explanation element is DEPRECATED and considered bad style to use, since you are supposed to change
 * the code to something better and more readable!
 *
 * 
 */
@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE})
public @interface WTF {

    /**
     * Optionally specify <code>explain</code>, and write why you dont understand this annotated element
     */
    String explain() default "";

    /**
     * Optionally add <code>explanation</code>, and to explain why and how the element should be used
     */
    @Deprecated
    String  explanation() default "";
}

WTF.java

@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE})
public @interface WTF {

    /**
     * Optionally specify <code>explain</code>, and write why you dont understand this annotated element
     */
    String explain() default "";

    /**
     * Optionally add <code>explanation</code>, and to explain why and how the element should be used
     */
    @Deprecated
    String  explanation() default "";
}