4 ms·
> This code is functional, but if you are going to do another iteration you may want to consider the following improvement or optimization. I assign the same m
by kanox 7y ago
> This code is functional, but if you are going to do another iteration you may want to consider the following improvement or optimization.
I assign the same meaning to TODO or FIXME markers but a lot of people see this is as a measure of poor quality so instead I write regular comments of the form "this could be made better by doing X and Y".
- somehnguy 7y agoThat may work but I find those comments tend to get lost over time. TODO/XXX/FIXME support are built into IntelliJ which makes stuff like that super easy to find. If some random dev looks and decides its low quality because of those words...well I don't care because its a silly metric to judge on.
- TeMPOraL 7y agoAnd even if they aren't supported by default in your IDE/editor, they're perfect hooks for recursive grep. A simple grep -rn TODO * and you see a nice list of all of them, with files and lines.
- delusional 7y agoIntellj also supports custom "patterns". "Intellj supports it" is a pretty meaningless argument anyway.
- somehnguy 7y agoYeah I know I could define custom patterns and all that...but why? "Intellj supports it" means it makes my and the people on my teams lives easier. Instead of deciding on some arbitrary other thing we just use what the tool defaults to. Hardly a meaningless argument.
- kanox 7y ago> those comments tend to get lost over time That's fine, they don't need to be tracked. There are other systems for issues that need tracking.