CommentExtractor

概要

ダウンロード

• Jar ファイル： CommentExtractor.jar Ver. 0.1（39KB）

• ソースファイル： GitHub

使い方

• 入力では「メソッド（関数）位置リスト」として， ソースファイルのパスと対象メソッドの開始行及び終了行をタブ区切りで 一行ずつ標準入力から与える．
  なお，この「メソッド（関数）位置リスト」は
  

  ファイルパス    メソッド（関数）開始行   メソッド（関数）終了行

  の繰り返しとする．
  Java ソースファイルを対象とする場合， JavaMethodExtractor.jar の出力から第二フィールドを捨てたものに相当するため， 簡易的なフィルタとしてはパイプとして "| cut -f 1,3,4" を利用するとよい．
  つまり，
  

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

  という具合いである．

• 出力形式は

  "ファイルパス    開始行    終了行" に続いて， 行番号，タイプ番号（以下のタイプ 1--7 のいずれか），コメントの内容，
  の順に列挙される． すべての区切り文字はタブである．

  • タイプ1 ： //...
  • タイプ2 ： /*...*/
  • タイプ3 ： /**...*/ ただし，当該メソッドの直前に書かれたもの（Java 限定；C/C++ の場合は 0 となる）
  • タイプ4 ： 当該メソッドの直前に書かれたタイプ 1 コメント
  • タイプ5 ： 当該メソッドの直前に書かれたタイプ 2 のコメント
  • タイプ6 ： タイプ 1 によるコードのコメントアウト
  • タイプ7 ： タイプ 2 によるコードのコメントアウト
    （タイプ 4 及び 5 は Javadoc に準ずるものとも見なせるため，ここではあえて区別してある．）

  なお，指定されたメソッド（関数）にコメントが書かれていない場合は，
  "ファイルパス    開始行    終了行    ---"
  だけが出力される．