CommentCounter

Summary

Download

• Jar file: CommentCounter.jar Ver. 0.1 (31KB)

• source files: on GitHub

Usage

• CommentCounter reads method(function)-position-list from the standard input.
  method(function)-position-list consists of one or more text lines describing the positional data of methods(functions) to be measured. One line corresponds to one method(function). Each line consists of three data separated by Tab character: (1) the source file path, (2) the start line number of the method(function), and (3) the end line number of the method(function).
  

  filepath    begin   end

  
  For Java source files, the above list can be generated by JavaMethodExtractor.jar as
  

     java -jar JavaMethodExtractor.jar xxx.java | cut -f 1,3,4 | java -jar CommentCounter.jar

• CommentCounter prints the above positional data followed by the numbers of comment lines. Those numbers are corresponding to the following seven types, respectively (the delimiter is Tab):

  • type-1 : //...
  • type-2 : /*...*/
  • type-3 : /**...*/ (written just before the method declaration) (Java only; the value will be 0 for C/C++)
  • type-4 : type-1 comments written just before the method(function) declaration
  • type-5 : type-2 comments written just before the method(function) declaration
  • type-6 : type-1 comments as comment-out
  • type-7 : type-2 comments as comment-out