https://github.com/hiimsergey/dntodo

How I'm writing TODOs
https://github.com/hiimsergey/dntodo

backus-naur backus-naur-form backus-naur-form-lang backus-naur-form-language backus-normal-form bnf ebnf ebnf-lang ebnf-language ebnf-syntax todo todos

Last synced: about 2 months ago
JSON representation

How I'm writing TODOs

• Host: GitHub
• URL: https://github.com/hiimsergey/dntodo
• Owner: hiimsergey
• Created: 2024-08-29T10:36:17.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T14:06:18.000Z (4 months ago)
• Last Synced: 2024-08-30T13:12:55.935Z (4 months ago)
• Topics: backus-naur, backus-naur-form, backus-naur-form-lang, backus-naur-form-language, backus-normal-form, bnf, ebnf, ebnf-lang, ebnf-language, ebnf-syntax, todo, todos
• Homepage:
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Declarative Notation for TODOs

How I'm writing TODOs in my coding projects.

## Description

- "TODO" as first word, optional expressions follow

- Expression : one of multiple tags and/or verbal description follows (optional, actually)

    - separation of multiple expressions with "+"

    - `?` finally: option

        - `??`: doubt

- Tag: one word in ALL-CAPS, category of the todo

    - multiple tags in a row: precision, subcategory of the todo

- Description: anything else, although nothing holds you back from using ALL-CAPS too

## EBNF form

```html

 = "TODO" [ {" +" }]

 = ( |  |  )

 = {" " }["?" ["?"]]

 = {" " }

 = {}

 =  { | }

             |  

 = "A" | "B" | ... | "Z"

 = "a" | ... | "z" | 1 | ... | 9 | "-" | "_" | "." | ...

```

## Frequently used tags (by me)

| Tag | Meaning |

| -            | -                                                              |

| **CONSIDER** | think about keeping this code                                  |

| **DEBUG**    | debug this part                                                |

| **END**      | do this when you're done with the rest                         |

| **FINISH**   | complete a part that you started                               |

| **MEMORY**   | fix memory management here                                     |

| **MOVE**     | move this code to another place or file                        |

| **NOTE**     | temporary notes in the code                                    |

| **NOW**      | resume here on the next session                                |

| **PLAN**     | description of the structure of the code you're about to write |

| **TEST**     | this code is for testing/debugging, remove later               |

## Examples

```c

// TODO

// TODO this doesn't make sense

// TODO CONSIDER using recursion over a loop

// TODO END TEST

// TODO NOW DEBUG wrong value of foo

// TODO TEST + FINISH

/* TODO PLAN

debug the algorithm

write another one

fix the new bug there

consider farming

*/

```