Source code annotation tool

Posted by RoToRa on Stack Overflow See other posts from Stack Overflow or by RoToRa
Published on 2010-05-21T08:16:34Z Indexed on 2010/05/21 8:20 UTC
Read the original article Hit count: 287

Filed under:

source-code

|

annotation

|

JavaScript

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.

© Stack Overflow or respective owner

Related posts about source-code

svn: Syncing main source code with committed source code

as seen on Server Fault - Search for 'Server Fault'
To manage my source code I have created SVN subversion server by using command svnadmin create /myrepos svn import /root/MySourceCode file:///myrepos I have created user and provided rw access to him. User can easily commit their changes in repository. How can I update my sourcecode (/root/MySourceCode)… >>> More
Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
Freelancing - Share the source code?

as seen on Programmers - Search for 'Programmers'
I have developed a couple of form based windows application in vb.net for a client and they all work well and he paid me through a freelance site. I have handed over the executable and the setup to the client and all was well. Now the client wants the source code for the application. Is there a general… >>> More
Software for "High-level" source code (C++) Management

as seen on Programmers - Search for 'Programmers'
after a lot of small-medium projects, I have a lot of libraries and test programs here and there. Also, I must admit that some of the "best practices" I learnt are not that "good" IMHO. In particular, documenting your code and making a "high-level" documentation is not useful in practice: High-level… >>> More
Static source code analysis for C# that operates on source code level

as seen on Stack Overflow - Search for 'Stack Overflow'
Current static source analysis tools for C# (or other .NET languages) usually operate on the assembly-level. They use reflection to analyse the code. Are there tools available that operate on a source code level only (like lint for C)? >>> More

Related posts about annotation

uimapview annotations ordering

as seen on Stack Overflow - Search for 'Stack Overflow'
i add annotation one by one but annotation may be need some overlapping but the annotation overlapping another annotation look like random. sometimes annotation 1 overlap annotation 2 sometimes annotation 2 overlap annotation 1 how can i force annotation 1 overlap annotation 2? Thank you >>> More
annotationView didChangeDragState being fired multiple times

as seen on Stack Overflow - Search for 'Stack Overflow'
I've got a draggable annotation in IOS4 mapkit, and I'm trying to call an event when the annotation is dragged to a new position. my code currently looks like: - (void)mapView:(MKMapView *)mapView annotationView:(MKAnnotationView *)annotationView didChangeDragState:(MKAnnotationViewDragState)newState… >>> More
MKMapView loading all annotation views at once (including those that are outside the current rect)

as seen on Stack Overflow - Search for 'Stack Overflow'
Has anyone else run into this problem? Here's the code: - (MKAnnotationView *)mapView:(MKMapView *)mapView viewForAnnotation:(WWMapAnnotation *)annotation { // Only return an Annotation view for the placemarks. Ignore for the current location--the iPhone SDK will place a blue ball there. NSLog(@"Request… >>> More
Javassist annoations problem

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm trying to generate my Entity class using javassist. Everything went well until I added the GeneratedValue annotation to the Id field. The @Id annotation works fine but when I add @GeneeratedValue I get an exception. This is my code: ClassPool cp = ClassPool.getDefault(); CtClass ctClass =… >>> More
Why would a WebService return nulls when the actual service returns data?

as seen on Stack Overflow - Search for 'Stack Overflow'
I have a webservice (out of my control) that I have to talk to. I also have a packet-sniffer on the line, and (SURPRISE!!!) the developers of the webservice aren't lying. They are actually sending back all of the data that I requested. But the web-service code that is auto-generated from the WSDL… >>> More