Comment Headings (beta)

Enable easy navigation of code using GIANT comments made up of block characters

Posted on Saturday, June 7th, 2008 at 12:26 pm

When navigating through large classes, it can be a real pain to find certain bits of code if you don’t have a good IDE. As I often work in Flash IDE and DreamWeaver IDE, I have to rely on comment blocks here and there, with lots of ———- delimiters, etc. which is an OK start.

However, I saw the PaperVision 3D classes had moved on a step from this, and had rather nice blocks at the top of each script with their logo, made out of characters. Why not extend this idea and actually build a small Flash application to let me build dirty-great big words that I can use in my scripts for navigation purposes?

Comment Headings beta

Edit the text in the left-hand text box to update the text in the right, then copy and paste to your IDE.

You’ll need to be using a monospaced font to make it work! Mac users, you might have to experiment to find the best one…

UPDATE: the characters below do not appear to display properly in Firefox 3. Investigating…

Final release

The final release, which I’m working on in my spare time, will have:

  • a greater range of typefaces to choose from
  • options for other languages (ie, MaxScripters will be able to choose — for their comment delimiter)
  • more options with regards to the content and formatting of the comments
  • options to remember your last headings
  • Will be built on the MVC design pattern

Feel free to make suggestions below.

Download

Make a comment or suggestion...

  • Anti-spam: enter the characters in the image (required).