search

readyou / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

@todo tag #225

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
This is more a feature request, not a defect.

You should consider implementing a @todo [comment] tag for developer notes.
This hugely increases productivity during development as it is easy to mark
later improvements in a method/class which right now are not required. This
is even more true for agile development cycles.

See PHPDoc
(http://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_tag
s.todo.pkg.html)
For an in depth presentation.

Regards,
Dominique

Original issue reported on code.google.com by saloon12...@googlemail.com on 7 Jul 2009 at 9:46

GoogleCodeExporter commented 9 years ago

Original comment by micmath on 11 Jul 2009 at 11:05

GoogleCodeExporter commented 9 years ago 
How would the output appear if a doc comment contained a @todo tag?

Original comment by micmath on 26 Jul 2009 at 10:56

GoogleCodeExporter commented 9 years ago

Original comment by micmath on 26 Jul 2009 at 11:02

GoogleCodeExporter commented 9 years ago 
Output would be very simple, similar to what is used for the other tags. The 
@todo
usually contains a simple 'reminder' like '2009-08-10: implement method' or 'add
proper error handling'.

So all that is required is a text in the generated jsdoc.

Thanks for considering this.
Dominique

Original comment by saloon12...@googlemail.com on 10 Aug 2009 at 9:27

GoogleCodeExporter commented 9 years ago 
I'd suggest doing this as a custom tag, rather than making it part of the JsDoc 
spec for the app.

http://code.google.com/p/jsdoc-toolkit/wiki/FAQ#Using_custom_tags

Original comment by micmath on 21 Aug 2009 at 1:49