Update: The code I wrote that was here was poor, so I removed it. For a complete solution that works well see my Ctext highlighting widget: http://www.xmission.com/~georgeps/ctext/
Also see Jeffrey Hobbs' "Tcl source code to HTML compatible format converter. Does some intelligent highlighting" at http://www.tcl.tk/community/hobbs/tcl/script/main.html