[Feature Request] TODOs about papercut

[StefMa]

Where is the benefit to use a annotation instead of a comment like

//TODO do stuff

[Stuie]

Given that you're happy with your solution, and the feature request is essentially to duplicate/rename an annotation with no new behavior I'm just going to close it for now.

I'll keep a rename in mind, and especially if I get another feature request along the same lines.

[vibin]

I cannot cause a build failure with // TODO do stuff.

[Stuie]

With the annotation you could choose to fail for certain instances, and not for others.

Perhaps you want to fail for placeholder strings but not for adding javadoc, etc.

Tools like Checkstyle don't have that level of granularity.

[Stuie]

@vibinr Can you think of any specific new behavior that you would need for a @Todo that you couldn't just do with @Refactor? Is it simply a naming issue for you?

I don't want to end up with many annotations with duplicated behavior if I can avoid it. :)

[vibin]

I want the build to fail each time I do @todo with stopShip = true. So, same as @refactor, including targeted element types, just the name is different.

Don't think I understand Checkstyle's relevance here...

[vibin]

@Stuie yeah, it's just a naming thing. "Refactor" just doesn't go right for everything apparently.

[Stuie]

@vibinr I was responding more to @StefMa's question

Where is the benefit to use a annotation instead of a comment

You can set up Checkstyle to fail a build when it finds a // TODO or // FIXME comment, but you don't have the same level granularity of control with that, as you may want some of them to fail the build, but not all of them. This is especially the case if you're in a large existing codebase with comments like that in multiple places. An annotation is much more fine-grained.

If you're starting with a brand new codebase then arguably Checkstyle makes more sense.

There was a thread about this on Reddit if you're interested in reading more.

[vibin]

@Stuie Yeah, that makes sense. What do you think of entirely replacing @refactor with @todo?

[vibin]

Got this functionality working with Android lint's StopShip instead 😀
http://stackoverflow.com/questions/33504186/how-to-make-grade-release-build-fail-using-lint-option-stopship