Source code annotation tool

I'm looking for a tool with which I can annotate source code.

I have some 3rd party source code (JavaScript) I need to understand and I don't want to change it (add inline comments) so that

  • line numbers can stay intact (for communication with others),
  • I can avoid accidentally changing something and
  • my annotations stand out compared to the authors comments.

Normally I would print the whole thing out an scribble on it, but the code is too long for that and I need to share it per email. I would be great if one could do some like that including being able to create "links" between so places in the code, possibly even visually with a lines or arrows.

Answers


If you would usually print it (if it were shorter), why not print it to a PDF and then use a PDF viewer that supports comments, like Foxit Reader? :)


I would use email to comment and pastebin to host and highlight @h@ lines with links in the email text. OR some code-review tool (like codestricker or reviewboard for example)


You can certainly do what you want to with LaTeX and its listings package. But if you are not already a LaTeX user you might think that a hard way to go.


start a github project and post the code there, github includes annotation abilities OOB.


You have difficult requirements. I don't know of such tool. Nevertheless as a more general purpose tool, I can recommend Yui Doc (download here).


I'd build a glamour browser for it. (If spending half a day building it wouldn't be too much).

[edit] Glamour is a toolkit for building browsers on a model. The model would here consist of the various parts of the file(s) and the comments and attributes you'd like to add. This would allow you to easily navigate through the source and comments, to select only parts with (or without) certain attributes. There is a video and slides. Official page, Source


How about using google wave with syntaxy (http://wave-samples-gallery.appspot.com/about_app?app_id=14008) bot?


Need Your Help

complete styles for cross browser CSS zoom

css css3 cross-browser zoom

I am finding it hard to get fully cross browser CSS zoom properties ..what I've is only these

Expand a div to take the remaining width

html css css3 multiple-columns

I want a two-column div layout, where each one can have variable width e.g.