SLCounter 操作マニュアル

概要

SLCounterは、気軽に使えるGUI型のソース行カウンタです。プロジェクトの開発規模の把握やプログラミングの進捗管理に利用します。更にお好みのエディタを起動するランチャ機能も備えているため、ソースの表示や変更が楽です。集計結果をCSVファイルに出力できるため、報告書を作成するのに役立ちます。更にレジストリも汚しません。

１．特徴

集計項目は全行数、プログラム行数、コメント行数、空白行数
- 一般的なソースコードカウンタと同様、各ソースファイルの全行数、プログラム行数、コメント行数、空白行数の４項目について集計します。
対応ソース種別は JAVA、C/C++、C#、ヘッダファイル、JSP
- 集計対象ファイルは、今のところ JAVA、C/C++、C#、ヘッダファイル、JSPです。環境設定でデフォルトの集計対象ファイルを選択できます。集計メイン画面上で臨時に選択可能です。対応ソース種別に関しては要望があれば増やします。
対応文字コードは Shift-JIS、JIS、UTF-8、EUC-JP
- 読み込むことができる文字コードは、Shift-JIS、JIS、UTF-8、EUC-JPの４種類です。集計対象のソースに、異なった文字コード体系のファイルが混ざっていても自動判定して集計します。対応文字コードは、必要があれば増やします。
指定したディレクトリ下の全ソース集計して結果を表形式で表示
- 指定したディレクトリの下の全ソースを集計し、その結果を表形式に表示します。また、表示されているソース一覧表のタイトルをクリックすると、昇順あるいは降順に表示順序を変えることができます。
エディタランチャ機能
- 一覧に表示されているソースファイルをダブルクリックすると、設定したエディタで開くことができ、ランチャとしても使用できます。起動するエディタは、初期設定ではnotepadになっていますが、秀丸等のポピュラーなエディタに置き換えることが可能です。
直前に集計したディレクトリパス情報を保持
- 起動のたびに、集計先ディレクトリを指定するのは面倒です。SLCounterは、前回に集計したディレクトリパス情報を保持しますので、再起動時に集計先ディレクトリのパスを指定する必要がありません。
集計結果をCSVファイルに出力
- 集計結果をCSVファイルとして任意の位置に出力できます。EXCEL等に出力することも容易でしたが、環境によってはインストールされていないことがあり、CSVのほうが無難で汎用性があるという判断により、とりあえずCSVのみとしました。もちろん要望があれば追加します。
レジストリを汚さない
- SLCounterは、レジストリを使用していませんのでインストール、アンインストールが非常に楽です。

２．動作環境

SLCounterは、以下の環境で動作します。

動作OS　　　　　　　　　　　　　　　： Windows XP／Vista　(※1)
必要ハードディスク容量　　　　　　： 100KB以上（マニュアル含む）
必要メモリ容量　　　　　　　　　　　： 128MB以上
ランタイム　　　　　　　　　　　　　　： .NET Framework 2.0/3.0/3.5　(※2)

　(※1) Windows 7 については動作未確認です。
　(※2) Windows XPの場合、通常 .NET Framework がインストールされていませんので、マイクロソフトから .NET Framework 3.5 をダウンロードしてインストールしてください。.NET Framework 3.5 は .NET Framework 2.0 も含んでいるからです。なお、最新の .NET Framework 4.0 は、.NET Framework 2.0 を含んでいないので動作しません。
　Windows Vista については、デフォルトで .NET Framework 3.0（2.0含む）がインストール済みのはずなのでそのまま動作します。もし動作しない場合は、.NET Framework 3.5 をインストールしてください。

SLCounterのインストールとアンインストール

１．インストール手順

SLCounterのインストール手順は、非常にシンプルです。
SLCounter一式ファイル（SLCounterxx.lzh：xxはバージョン番号）を解凍して適当なディレクトリ（"D:\SLCounter"等）に置きます。これでインストール完了です。
内容は、SLCounter.exe、SLCounter.confと当マニュアルが存在するサブディレクトリです。

２．アンインストール手順

SLCounterのアンインストールは、SLCounterを配置したディレクトリ以下を全て消せば完了です。

SLCounterの操作手順

起動と環境設定

C:\SLCounterディレクトリにある SLCounter.exe をダブルクリックして起動させます。

初回起動時は、「ソースディレクトリ」が起動したディレクトリになり、集計結果が空欄です。とりあえずこのままにして、まず環境設定を行ってください。
SLCounterの環境設定を行うには、「環境設定」のリンクをクリックしてください。次の環境設定ダイアログが表示されます。
「エディタ選択」ボタンを押してください。次のエディタ選択ダイアログが表示されます。
以下の画面は、エディタ選択ダイアログにおいて、秀丸を選択した場合のものです。

実行可能なEXEファイルであること
コマンドラインの起動ができ、かつ引数にテキストファイル名が設定できること

「デフォルト設定」の四角の中は、起動直後の選択状態を設定するための項目です。それぞれ必要な項目をチェックしてください。以下の例は、全てチェックした状態のものです。

「対象ソース種別」は、集計するソースの種別を選択するための項目です。
「起動時に前回参照したディレクトリを集計する」のチェックボックスは、SLCounterを起動すると同時に、記憶されている前回集計ディレクトリについて集計するかどうかを選択するための項目です。
「下位ディレクトリのソースも集計する」のチェックボックスは、集計時に下位のサブディレクトリにあるソースファイルを集計対象にするかどうかを設定するための項目です。
環境設定が終了したら、エディタ選択ダイアログの「設定」ボタンを押してください。変更した内容がSLCounterの環境設定ファイル（SLCounter.conf）に保存されます。なお、環境設定を取りやめる場合は、「キャンセル」ボタンを押してください。

集計

「対象ソース種別」の選択と「下位のディレクトリのソースも含む」かどうかを選択します。

「対象ソース種別」は、最初デフォルトの設定状態になっていますが、変更可能です。
ただし、ここで変更した状態は環境情報に保存されません。
また、「下位のディレクトリのソースも含む」の選択も同様に随時変更可能ですが、環境情報に保存されません。
集計先のディレクトリを選択します。「ディレクトリ選択」ボタンを押してください。
次のディレクトリ選択ダイアログが表示されます。

集計先のディレクトリを選択し、「OK」ボタンを押してください。
集計ボタンを押します。
集計実行後の画面の例です。

集計結果画面について少し説明しておきます。
1. 項目のタイトルをクリックすると、その項目の昇順または降順に表示の並びを変更できます。
2. FormSLCounter.cs等のソース名をダブルクリックすると、そのソースファイルが設定したエディタに読み込まれ、表示されます。ソースの起動手順は次の項を参照してください。

エディタ起動

特定のソースを開きたい場合は、以下のようにソース名をダブルクリックしてください。

次の画面のように、設定したエディタによりソースファイルが開きます。

ファイル保存

「CSVファイル出力」ボタンを押してください。
CSVファイル保存ダイアログが表示されます。デフォルトで、”ソース集計結果_”＋ タイムスタンプ14桁 ＋ ”.csv”のファイル名になっています。もし、他のファイル名で出力するならばファイル名の欄に表示されている名称を修正します。
以下に出力するCSVファイルの例を示します。

出力項目は、「No.」、「ソース名」、「タイムスタンプ」、「全行数」、「ソース行数」、「コメント行数」、「空白行数」、「パス情報」の８項目です。
また、「合計行」も出力されます。もし不要な項目や行があるならば、エディタあるいはExcelなどで読み込み、必要な項目だけにしてください。

リリース履歴

2010.09.08 Ver.1.0（初版）リリース