Information about CodeAnnotator

About

The goal of CodeAnnotator is to help people communicate about code.

The project was inspired not out of formal software engineering practices like code reviews, but rather the need for instructors to provide effective feedback to students about program submissions. Code review software is overkill and not easily usable by students. Printing programs out and commenting by hand is inconvenient and a waste of paper. Converting code to PDFs and marking them up digitally is messy and raises issues about how best to share the resulting files with students.

Features

CodeAnnotator has lots of features. For more information about features, check out CodeAnnotator's Features page on GitHub.

Here's a short list of some of the major features:

• Support for any text file
• Syntax highlighting for many of the most common programming languages
• Organize files by project, and by directories within projects
• Attach comments to specific location in a file
• Comments can be attached to multiple locations within and between files in a project
• Provide alternate code for a selection within a file
• Uploading files
  • Multi-file and zip file uploading
  • Batch uploading with optional updating
• Sharing
  • Share a project so others can: view, annotate (add comments and alternate code), or author (add/remove files, delete the project)
  • Share with other CodeAnnotator users via their username (email)
  • Generate unlimited named public links. Anyone with a link can view the project, and links can be revoked at anytime.

Help

If you are uncertain about how to do something you think you should be able to do with CodeAnnotator, begin by familiarizing yourself with the features (see above). Next, take a look at our Frequently Asked Questions page on GitHub.

If you are experiencing problems with slowness, loss of data, account issues, etc., please contact the website maintainer here: annotate@feild.org.

For issues pertaining to the software itself, please submit an issue to the project's GitHub page. We are also very happy to hear about any feature requests you have—please submit them as issues, tagged with "feature request"!