The @Todo Tag


	Resources

	FAQ Online Help File Examples External Links


	Online Help File

	The Time2HELP help file is available online.


	Order Time2HELP

	Order Time2help and pay by credit card, check or bank transfer.

	Order online from Kagi.


	Download trial version

	Download the 30 day trial version of Time2HELP now.


Painless Documentation for your Source Code



		Home Features Download Support News Order

The @Todo Tag

Syntax

@todo description

Synonyms

None.

Description

This is info for the coders (only) of the class, method or routine. A @todo is something which is meant to be fixed before the next release. It is not the same as @bug, because a bug may be too expensive to fix, or otherwise does not warrant it being fixed. A @todo is often "stronger" than @bug, but not necessarily so. Use one tag per "todo". Can be used everywhere.

Time2HELP generates reports listing all the @todo's and @bug's found in a library/project.