Comments on: Tip: get your TODOs out of the comments http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/ letting the problem solve itself Sat, 23 Jan 2010 21:00:43 -0800 http://wordpress.org/?v=2.9.2 hourly 1 By: Steve Freeman http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-39182 Steve Freeman Tue, 22 Apr 2008 16:00:42 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-39182 Another Smalltalk idea rediscovered... In those days it was the best way to search the image. Another Smalltalk idea rediscovered… In those days it was the best way to search the image.

]]> By: Fernando Boaglio http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23477 Fernando Boaglio Mon, 11 Jun 2007 13:12:55 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23477 Since Eclipse can easily list all my TODO comments I never thought about that. Using your method you can use a "priority" approach (just like Bugzilla) which can solve my problem: where should I start fixing my code? Since Eclipse can easily list all my TODO comments I never thought about that.
Using your method you can use a “priority” approach (just like Bugzilla) which can solve my problem: where should I start fixing my code?

]]> By: chris clarke » Getting your TODOs out of comments http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23275 chris clarke » Getting your TODOs out of comments Fri, 08 Jun 2007 22:12:33 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23275 [...] Thoughtworker Carlos Villela talks about Getting your TODOs out of comments. [...] [...] Thoughtworker Carlos Villela talks about Getting your TODOs out of comments. [...]

]]> By: Sidu http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23168 Sidu Thu, 07 Jun 2007 12:59:13 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23168 IntelliJ can parse TODO comments and list them (Alt+6). In fact, I think you can get IDEA to treat them as warnings in Inspections. Where it falls over is if you want this as part of your build, which is where it would be really useful. Nice idea! IntelliJ can parse TODO comments and list them (Alt+6). In fact, I think you can get IDEA to treat them as warnings in Inspections. Where it falls over is if you want this as part of your build, which is where it would be really useful. Nice idea!

]]> By: Master of Nothing http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23160 Master of Nothing Thu, 07 Jun 2007 12:16:59 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23160 Very interesting approach indeed. I have used //TODO comments extensively when developing in Java and I was able to track them easily in both Eclipse and IntelliJ IDEA. Comment approach was good but it never forced you to address the TODOs like what you have suggested :). Very interesting approach indeed. I have used //TODO comments extensively when developing in Java and I was able to track them easily in both Eclipse and IntelliJ IDEA. Comment approach was good but it never forced you to address the TODOs like what you have suggested :) .

]]> By: Tom Adams http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23129 Tom Adams Thu, 07 Jun 2007 00:11:07 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23129 I use a similar thing on Instinct, but instead of methods, I use annotations. I have two, Suggest which is for suggestions for improvement, and Fix, which is for things that are broken & need to be fixed. You can even tie the fix comments to a release number, implying they need to be fixed before the release is out. This is one way of making sure not too many of them get out the door & the number doesn't keep increasing. I don't have the release build failing yet if there are fixes left for that release, but it's planned. One of the good things with this is that you can embed strongly typed information into the annotation, such as story card details, pair information, etc. You can also easily track it using find usages in your IDE. Here's an example of a Fix: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/expect/ExpectThatImpl.java And here's a Suggest: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/runner/StatusLoggingContextRunner.java I use a similar thing on Instinct, but instead of methods, I use annotations.

I have two, Suggest which is for suggestions for improvement, and Fix, which is for things that are broken & need to be fixed. You can even tie the fix comments to a release number, implying they need to be fixed before the release is out. This is one way of making sure not too many of them get out the door & the number doesn’t keep increasing. I don’t have the release build failing yet if there are fixes left for that release, but it’s planned.

One of the good things with this is that you can embed strongly typed information into the annotation, such as story card details, pair information, etc. You can also easily track it using find usages in your IDE.

Here’s an example of a Fix: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/expect/ExpectThatImpl.java

And here’s a Suggest: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/runner/StatusLoggingContextRunner.java

]]> By: Tom Adams http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23121 Tom Adams Wed, 06 Jun 2007 22:11:40 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23121 I use a similar idea on Instinct, but instead of methods, I use annotations. I have two, Suggest which is for suggestions for improvement, and Fix, which is for things that are broken & need to be fixed. You can even tie the fix comments to a release number, implying they need to be fixed before the release is out. This is one way of making sure not too many of them get out the door & the number doesn't keep increasing. I don't have the release build failing yet if there are fixes left for that release, but it's planned. One of the good things with this is that you can embed strongly typed information into the annotation, such as story card details, pair information, etc. You can also easily track it using find usages in your IDE. Here's an example of a Fix: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/expect/ExpectThatImpl.java And here's a Suggest: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/runner/StatusLoggingContextRunner.java I use a similar idea on Instinct, but instead of methods, I use annotations. I have two, Suggest which is for suggestions for improvement, and Fix, which is for things that are broken & need to be fixed. You can even tie the fix comments to a release number, implying they need to be fixed before the release is out. This is one way of making sure not too many of them get out the door & the number doesn’t keep increasing. I don’t have the release build failing yet if there are fixes left for that release, but it’s planned.

One of the good things with this is that you can embed strongly typed information into the annotation, such as story card details, pair information, etc. You can also easily track it using find usages in your IDE.

Here’s an example of a Fix: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/expect/ExpectThatImpl.java

And here’s a Suggest: http://instinct.googlecode.com/svn/trunk/core/src/main/java/com/googlecode/instinct/runner/StatusLoggingContextRunner.java

]]> By: Brian Guthrie http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23116 Brian Guthrie Wed, 06 Jun 2007 18:47:50 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23116 That's a great idea. You can even extend it to automatically detect the current method or class, by using a method_added callback in class Class, or generating the appropriate method handle from call_stack. You could also use call_stack to find line numbers and generate HTML output or something. class Foo TODO :btg, "1/1/2007", "fix this" def broken_method(...) end end Foo.todos #=> { :broken_method => "fix this" } That’s a great idea. You can even extend it to automatically detect the current method or class, by using a method_added callback in class Class, or generating the appropriate method handle from call_stack. You could also use call_stack to find line numbers and generate HTML output or something.

class Foo

TODO :btg, “1/1/2007″, “fix this”
def broken_method(…)
end

end

Foo.todos #=> { :broken_method => “fix this” }

]]> By: Guilherme Chapiewski http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23114 Guilherme Chapiewski Wed, 06 Jun 2007 18:02:07 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23114 Sounds good. This seems also to prevent TODOs from never leaving the code (which happens very frequently). :) Sounds good. This seems also to prevent TODOs from never leaving the code (which happens very frequently). :)

]]> By: Sam http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/comment-page-1/#comment-23099 Sam Wed, 06 Jun 2007 16:36:17 +0000 http://www.lixo.org/archives/2007/06/06/tip-get-your-todos-out-of-the-comments/#comment-23099 Maybe you could even break the build if a TODO is older than a few months. That way it'll force you to make decisions about todo's that are hanging around. Maybe you could even break the build if a TODO is older than a few months. That way it’ll force you to make decisions about todo’s that are hanging around.

]]>