In my humble opinion, quality control begins at the simple fact of evaluate how much comment lines proliferate in any program. Here is a simple GUI to perform this tasks. It prints :
-- Sarnold 13/01/2006
proc LinesNComments {file} {
set fd [open $file r]
set comments 0
set lines 0
while {![eof $fd]} {
gets $fd line
set line [string trimleft [string trimleft $line \t]]
if {[string equal $line ""]} {
continue
}
# skip comments lines with no words
if {[string index $line 0]=="#"} {
if {![regexp {^\b*#+[a-zA-Z0-9]*} $line]} {continue}
incr comments
}
incr lines
}
close $fd
return [list $lines $comments]
}
wm title . "Check the use of comments in Tcl files"
button .inspect -command Inspect -text "Inspect file"
button .quit -command exit -text "Quit"
pack .inspect .quit
proc Inspect {} {
set file [tk_getOpenFile]
if {![file exists $file]} {tk_messageBox -message "No such file: $file";return}
foreach {lines comments} [LinesNComments $file] {}
set percentage [expr {double($comments)*100/double($lines-$comments)}]
tk_messageBox -message "file $file : $lines lines and $comments comments lines,
for 100 lines of code there are $percentage lines of comments"
}