michaelevans / gag Goto Github PK

What about being able to "like" code?

Something like:

/**
 * Indicates that the mentioned persons like or enjoy the annotated code.
 *
 * For example:
 *
 * <pre>
 *   &#064;Like(persons = "Joe")
 *   public class FluxCapacitor {
 * </pre>
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Visionary("yamass")
public @interface Like {
    String[] persons() default {};
}

Annotating a method with the @OnlyProvedNotTested annotation is a way of 
indicating to the reader/maintainer: "Beware of bugs in the above code; I have 
only proved it correct, not tried it."

It should take an optional string containing the actual proof, or a link to a 
document where the proof is written out.

An engineer who is spending his or her time writing unit tests would be advised 
to search the codebase for this annotation, and devote lots of time to writing 
tests for any method that has this annotation, at which point the annotation 
could be removed.

What about some IoC features on GAG?

@Gimme
private Ring<Gold> precious;

What steps will reproduce the problem?
1. When I pass this project link to friends.
2. When they buzz it! 
3. When its shared all over.

What is the expected output? What do you see instead?
"Zomg! I'm fooled ;)"

What version of the product are you using? On what operating system?
4.1 [ april.first ]

Please provide any additional information below.
Trying to find more such issues ;)

Please add @RTFM annotation with text link to document.

@See http://en.wikipedia.org/wiki/RTFM

Thanks.

noone will ever use another library for anything.

Here are some ideas for quick prototype code annotations, @yetToBeTested, 
@theoretical, or my favorite @thisShouldWork.

You could also add Website.CODINGCONFESSIONAL.

Generally accepted practice is to flag operations that are performed with 
unbelievable disregard for social custom with the tag @OhNoYouDi-int

Do eeeet

Please add an @OhNoYouDidnt with a fingerSnapCount attribute.

Because @PleaseDontShowUpOn(THEDAILYWTF) is a sentiment that needs expressing.

What steps will reproduce the problem?
1.
2.
3.

What is the expected output? What do you see instead?


What version of the product are you using? On what operating system?


Please provide any additional information below.

Currently, the library is a big win! But I think it's still missing a useful 
annotation. @SorryAboutThat would be a great addition to express desperation to 
coworkers, and we couldn't do it another way.

Thanks for such a useful tool!

What steps will reproduce the problem?
1. JDK 1.7.0_51
2. ant run-demo
3. VerifyError

What is the expected output? What do you see instead?

The demo output.


What version of the product are you using? On what operating system?

Linux, JDK 1.7.0.51.


Please provide any additional information below.

It'll be grate to use 
@AnswerToTheUltimateQuestionOfLifeTheUniverseAndEverything for classes and 
methods.

Might as well bake it in the compiled code. Something like Lombok does a great 
job at generated code from annotations, there's perhaps an easy way to take 
advantage their existing infrastructure.
(enabling the agent is a tad cumbersome)

Could you upload version 1.0 to the maven central repository (as per
http://maven.apache.org/guides/mini/guide-central-repository-upload.html)? 

Thanks,

Nick