Questions tagged [todo]

TODO is often used in code comments to indicate a task that needs to be done. IDEs often highlight them. Please do not use this for questions about creating todo list applications.

TODOs are source-code comments, stating that something still needs to be done in that particular section of the program.

Different syntaxes are used for different languages. A typical C-style example would be:

// TODO: Fix this

It has been debated whether todo comments are to be considered good or bad practice.

Most IDEs have the facility of highlighting TODOs and/or displaying them in a separate view.

224 questions
6
votes
2 answers

How to generate custom "todo" tags in JetBrains IDE?

I have figured out how to download and install new color schemes. It is after I did this that I noticed that IntelliJ will still color the following line yellow: // ToDo: implement Further, this coloration is independent of the color schemes I…
Chris
  • 28,822
  • 27
  • 83
  • 158
6
votes
1 answer

How to handle TODO comments when sonar error is encountered

We have an application which is big and we have added the TODO rule to the quality gates which gives error if TODO comments are found. If we just removing the TODO comment (which is scary) it works but the whol purpose of adding TODO comment is…
Metalhead
  • 1,429
  • 3
  • 15
  • 34
6
votes
2 answers

how to integrate TODO handling into the maven test phase?

suppose i have a project with lots of todos, some unintentionally left there, some no longer relevant, some represent future possible features etc. i know that most IDEs can show/filter/sort them, but im looking for a way to enforce a more strict…
radai
  • 23,949
  • 10
  • 71
  • 115
6
votes
3 answers

How do I handle TODO comments in VisualStudio 2010?

I'd like Visual Studio to list all lines having "TODO: " in their beginning (usually after a comment sign which may vary depending on the file type), that can be found in any textual file in a solution (whether it be C#, VB, F#, T-SQL, ASPX, XAML or…
Ivan
  • 63,011
  • 101
  • 250
  • 382
5
votes
2 answers

Why does gofmt remove indented TODO formatting?

It seems gofmt in go1.19 changed its behavior to not allowing indenting based on some heuristics (from go docs: https://tip.golang.org/doc/comment). But this breaks the TODO comment formatting. This is what I used to have in my code that gofmt…
5
votes
2 answers

TODO Tool window in Emacs?

I'm looking for a functionality like: the TODO tool window of IntelliJ IDEA (see https://www.jetbrains.com/help/idea/todo-example.html) or the Tasks list of Eclipse (see https://dzone.com/articles/to-do-lists-with-eclipse-tasks-view). And I'd like…
user3341592
  • 1,419
  • 1
  • 17
  • 36
5
votes
2 answers

git – order commits introducing "TODO"s by date

I want to find commits that introduced added a "TODO" or "FIXME" comment and order them by date. I know that git log -G'TODO|FIXME' will show me commits that contain either comment and I could do something like git log --format='%ci' -G'TODO|FIXME'…
Ingo Bürk
  • 19,263
  • 6
  • 66
  • 100
5
votes
3 answers

Extract # TODO tags from source code and convert them into Issues on Bitbucket / Github

Some IDE's like PyCharm offer ability to mark parts of source code with # TODO tags with further ability to locate all the tags later on. Is there any way to convert them into "Issues" after commit was made to Butbucket or Github? I find it might be…
Skylight
  • 211
  • 5
  • 14
5
votes
5 answers

How to use ant to check for tags (TODO: etc) in java source

it's common to see something like this in code, hopefully only during development: //XXX: not in production! String password = "hello"; // getActualPassword(...); ... catch(Exception e) { /* TODO: Auto-generated catch block*/ } I would like ant to…
Paul Adamson
  • 2,011
  • 2
  • 18
  • 22
4
votes
1 answer

TODO tags aren't found in Eclipse with PyDev

I'm using Eclipse with PyDev on OpenSUSE 12.1. I've got projects in Javascript and Python. By right click I can add a TODO, but since I'm working with other developers I'd like to have them as code comments so that they get synchronized with the…
Daniel Lee
  • 2,030
  • 1
  • 23
  • 29
4
votes
2 answers

Eclipse automatic todo task addition

Is there a way in eclipse to automatically add TODO task eg:- //TODO: TO BE TESTED to the top of the function or class so that i can easily keep track of the changes yet to be tested ?
Emil
  • 13,577
  • 18
  • 69
  • 108
4
votes
2 answers

Is it a good habit to write TODO to commit message?

I just realized that I prefer writing TODO notes directly in to the latest commit instead of issue tracker, for example: TODO: - Remove console.log - Check that XY works - ... For example if I have to switch to another job, finishing it and coming…
bimlas
  • 2,359
  • 1
  • 21
  • 29
4
votes
3 answers

How to insert TODO comment in React JSX file

I would like to insert TODO comments on a React JSX file, a regular JavaScript comments are parsed as text and rendered in my component PhpStorm list them in in TODO tool window // TODO any comments ... or /* TODO an other todo task*/ in case…
Ait Yahia Idir
  • 370
  • 4
  • 18
4
votes
2 answers

Why does the maven-assembly-plugin descriptor say in its example site?

Something that has always made me wonder with maven-assembly-plugin is that the jar-with-dependencies example file on the apache website has a TODO comment about a jarjar format. Is this just an artifact of code that keeps getting copied through…
4
votes
2 answers

Can I convert my TODO to a git bug?

I am new to Git and did not find any reference for such a question. One un-answered post here at StackOverflow is Similar Post, also I found this Possible similar problem but I did not find an answer there as well.. I have some //TODO
mestrebisli
  • 83
  • 1
  • 8