views:

26

answers:

2

Is there software that can add rich text or HTML comments to specific lines and sections of text-based source code files without modifying the source file?

I am looking to document some HP Basic software and the only program I can find is Microsoft Word. The Review pane allows me to tag comments to specific lines, but Word comments do not support inserting pictures. Furthermore, Word does not syntax highlight the code, making it difficult to read.

It seems software capable of this should exist, but I am just not searching for the proper buzz words.

A: 

Whats the use in not embedding the comments in the source file? Might "code folding" be the keyword you are looking for?

h0b0
The source file is an ASCII text file. I am attempting to create a programmers manual for the source code. Also, since the source file is an ASCII text file, there is no way to rich format or insert pictures.
lvb
A: 

There are various code review tools like Review Board and Code Collaborator that allow you to collaboratively annotate code for the purposes of review and approval.

I don't believe either of them support annotating with images but they both have a good commenting system and provide syntax highlighting and change diffs.

They are, however, geared towards code review rather than documentation, if documenting the code is your intent here then you might be better off with something like Doxygen that allows you to add comments to your code and will then genetate documentation for you.

Fraser Graham
Doxygen even allows you to add images. But I'm doubt that you would get a useful result because no BASIC-like language is supported by Doxygen.
h0b0
I looked at doxygen, but it did not work with HP BASIC and it extracts comments from the code. I am looking to add comments/metadata about the code without modifying the source file.
lvb