Description & Learning Section

Developers often leave inline annotations like TODO, FIXME, BUG, or NOTE to mark areas requiring work or immediate attention. Tracking these annotations systematically helps manage technical debt and ensures nothing is forgotten.

Key Features:

• Custom Tags: Specify any comma‑separated list of tags to extract (e.g. TODO,FIXME,BUG,NOTE).
• Context Lines: Choose how many lines before and after each match to include for clarity.
• Summary Counts: See total items and per‑tag counts at the top.
• Line‑by‑Line Details: Each match shows its line number, tag, description, and optional context snippet.

Why Use This Tool?

• Aggregate all inline code annotations into a single actionable list.
• Facilitate code reviews by surfacing outstanding tasks and known issues.
• Integrate with project workflows to convert comments into tracked tickets.

Example:

// TODO: Refactor this function
def add(a, b):
    return a + b  # FIXME handle overflow

# BUG: off‑by‑one error in loop
for i in range(n):
    process(i)
    

With Tags: TODO,FIXME,BUG and Context 1 the output might be:

Total items: 3
TODO: 1
FIXME: 1
BUG: 1

Line 1 [TODO]: Refactor this function
Context:
1: // TODO: Refactor this function
2: def add(a, b):

Line 3 [FIXME]: handle overflow
Context:
2: def add(a, b):
3:     return a + b  # FIXME handle overflow

Line 5 [BUG]: off‑by‑one error in loop
Context:
4: 
5: # BUG: off‑by‑one error in loop
6: for i in range(n):
    

This comprehensive output gives you both a high‑level summary and the exact code context, making it easy to convert comments into tasks and maintain your codebase.