cqfn / pdd

Command line toolkit for collecting TODO markers from your code, known as Puzzle Driven Development (PDD)
https://www.0pdd.com
MIT License
76 stars 25 forks source link

README.md doesn't describe how pdd handles multi lines comments #224

Closed php-coder closed 7 months ago

php-coder commented 1 year ago

The example on README.md seems outdated:

/**
 * @todo #234:15m/DEV This is something to do later
 *  in one of the next releases. I can't figure out
 *  how to implement it now, that's why the puzzle.
 */
void sendEmail() {
  throw new UnsupportedOperationException();
}

while it works, pdd doesn't require a leading space on the next paragraphs, so the following also works:

/**
 * @todo #234:15m/DEV This is something to do later
 * in one of the next releases. I can't figure out
 * how to implement it now, that's why the puzzle.
 */
void sendEmail() {
  throw new UnsupportedOperationException();
}

It would be nice: 1) update the example to remove a leading space as it isn't required anymore 2) describe pdd logic of handling multilines comments 3) provide an example of mixing a @todo comment and non-pdd comment