Animated Code Annotater

30/8/2006: AnnAnn updated. New version uses cross-platform, single HTML file

The Animated Code Annotater, hereafter referred to as AnnAnn, is a simple tool that assists teachers of programming languages to produce online explanatory material about writing programs.

It works from the premise that new programs are often created by starting out with a familar base (e.g. a hello world program) and then repeatedly making small changes (additions, alterations, movements) until the new program is finished. Each small change is accompanied by an explanation, probably referring back to material that has previously been taught at a conceptual level.

AnnAnn takes a base program and a file of annotated changes and produces an HTML file which shows a short description of each change that needs to be made, highlights the code that needs to be changed and the revised code with the changes highlighted. Each stage in the description is clicked through by the reader.

AnnAnn has been used extensively by the author as a lecturing tool for teaching programming to large groups. It has also been used in self-study environments for helping to understand complicated pieces of code.

Status of Development

The compiler is in beta status, having languished for several years in development hell. (Its output has still been used in lectures.) For information and source code, please contact lac @ ecs.soton.ac.uk. The so

Catalog

The following table catalogues all the 'explanations' that I have produced over the last couple of years for the courses that I have been involved in. All examples have been recompiled on the new compiler.

Sample Change File

For further information, please contact the author Les Carr.