Implementation of @TODO annotations, and a utility class for viewing them.
@TODO(description="This is a TODO")
class myClass {
...
}java -classpath TODO.java utils.todo.ViewTODO class_names...
A TODO feature makes development a easier, allowing programmers to keep track of the tasks they have to complete. Here there is an easy to use TODO annotation, and a class to view them all.
The TODO.jar file contains all the classes neccessary for everything to work, all that needs to be done is download the jar and add it to the classpath.
- Download TODO.jar
- Import TODOs in java files with
import utils.todo.TODO - Write @TODO annotations
- Include TODO.jar in classpath when compiling
- View TODOs with
java -classpath TODO.java utils.todo.ViewTODO class_names...
TODO annotations have the following syntax:
@TODO(key=value, key=value...)
Where key value pairs are one or more of the following:
description="a descriptive text" <- description is required.
priority=TODO.priority.[HIGH | MEDIUM | LOW | UNDEFINED]
tags={"tag1", "tag2"...}
Annotations can be placed on classes, fields, methods, constructors, and packages (since java 6 package annotations and documentation should be in package-info.java).
ViewTODO reports all TODOs to standard output (System.out).
java -classpath TODO.java utils.todo.ViewTODO class_names...
Ensure class_names are fully qualified.
Pull requests welcome.
GNU GPLv3