TKTemplate の使い方

TKTemplate の使い方を簡単に説明します。

基本操作

TKTemplate を起動する

TKTemplate .exe を実行します。

次のようなエラーが表示されて起動できなかったときは、Microsoft® .NET Framework 4 をインストールする必要があります。

Microsoft .NET Framework 4 のインストール方法」を参照してください。

画面 1-1: Windows 7 と Windows Vista のエラー画面(画面は Windows 7 のものです)
Windows 7 と Windows Vista のエラー画面

TKTemplate を終了する

ウィンドウを閉じるか、[ファイル] メニューの [終了] をクリックします。

画面構成

画面 1-2: TKTemplate 画面
TKTemplate 画面
メニュー バー
コマンドを表示します。
ツール バー
メニュー バーとほぼ同様のコマンドを表示します。
テンプレート ツリー
テンプレートを階層構造で表示します。
テンプレート エディター
テンプレートを編集します。
テキスト生成タブ
テンプレートからテキストを生成するときに使います。
ステータス バー
情報を表示します。

カテゴリー、テンプレートの追加

「カテゴリー」と「テンプレート」は、Windows のエクスプローラーでいうところのフォルダーとファイルに相当します。複数のテンプレートをカテゴリーで分類して管理できます。

[編集] メニューで、カテゴリーまたはテンプレートを追加したり、移動することができます。

画面 2-1: [編集] メニュー
[編集] メニュー

[編集] メニューのコマンドがグレー表示で使用不可になっているときは、テンプレート ツリーをクリックしてみてください。また、一番上の階層に追加したいときは、テンプレート ツリーの項目がない部分を右クリックして、コンテキスト メニューで追加してください。

テンプレートの編集

パラメーター

メールのひな形のように、一部が異なるだけの定型文は、異なる部分をパラメーター化してテンプレートを作ることができます。パラメーター部分はテキストを生成する際に置換されます。

画面 3-1: パラメーターを含むテンプレート
パラメーターを含むテンプレート
  1. パラメーターを追加して、名前を編集します。
  2. パラメーター記号(デフォルトでは「$」)で囲んだパラメーターの名前を、テンプレートのテキストに含めます。

特殊なパラメーター

プログラマーが「public string Name { get { return name; } }」のようなソースコードのテンプレートを作る際、「Name」と「name」の部分をそれぞれ別のパラメーターとして用意するのは面倒です。

そこで、テンプレートのテキストにパラメーターを埋め込む際に、パラメータの名前の先頭に特殊な記号を入れることで、パラメーターの置換処理を変更することができます。

記号 処理
(x) 先頭がアルファベットの場合、先頭の文字を小文字に変換
(X) 先頭がアルファベットの場合、先頭の文字を大文字に変換
(xx) アルファベットをすべて小文字に変換
(XX) アルファベットをすべて大文字に変換

先ほどの例では、次のようにテンプレートを作成します。これで、テキストを生成するときに一つのパラメーターに「name」か「Name」を入力するだけで済むようになります。

画面 3-2: パラメーターの特殊記号を使ったテンプレート
パラメーターの特殊記号を使ったテンプレート

テキストの生成

テンプレートからテキストを生成する方法は2種類あります。「一つ」だけ生成する方法と、一度に「複数」生成する方法です。

通常は一つだけ生成するケースがほとんどかと思います。一度に複数生成するケースは、プログラマーが「項目の一覧表からプロパティ宣言コードを生成する」といったケースです。

一つ生成

  1. テキスト生成タブの [一つ] を表示します。
  2. パラメーターがある場合はパラメーターの入力欄が表示されるので、置換したい文字列を入力します。
  3. [生成] をクリックします。クリップボードに生成されたテキストがコピーされます。
画面 4-1: テキスト生成タブの [一つ]
テキスト生成タブの [一つ]

複数をまとめて生成

パラメーターが一つもないテンプレートでは、複数をまとめて生成する意味がないため使えません。

  1. テキスト生成タブの [複数] を表示します。
  2. パラメーターの入力欄に、置換したい文字列を入力します。入力した行数の分だけ、テキストが生成されます。
  3. [生成] をクリックします。クリップボードに生成されたテキストがコピーされます。
画面 4-2: テキスト生成タブの [複数]
テキスト生成タブの [一つ]

クリップボードの内容をパラメーターの入力欄へ貼り付けることができます。パラメーターをタブで区切ったテキストであれば貼り付けることができますので、テキスト エディターで編集してからコピーしたり、Excel の表をコピーすることができます。Excel の列の順序に合わせてパラメーターの順序を設定しておくと便利です。

例1: C# プロパティ宣言

テンプレートを次のようにします。

/// <summary>
/// $プロパティ名$を取得または設定します。
/// </summary>
public $Type$ $(X)Name$
{
    get { return $(x)Name$; }
    set { $(x)Name$ = value; }
}

パラメーターを次のように入力して生成します。

画面 4-3: C# プロパティ宣言の生成
C# プロパティ宣言の生成

次のテキストが生成されます。

/// <summary>
/// 商品IDを取得または設定します。
/// </summary>
public int Id
{
    get { return id; }
    set { id = value; }
}

/// <summary>
/// 商品名を取得または設定します。
/// </summary>
public string Name
{
    get { return name; }
    set { name = value; }
}

/// <summary>
/// 価格を取得または設定します。
/// </summary>
public decimal Price
{
    get { return price; }
    set { price = value; }
}

例2: SQL の SELECT 文や INSERT 文での列名の羅列

テンプレートを次のようにします。

$column$

パラメーターを次のように入力して、[テキスト区切り] を「, 」にしてから生成します。

画面 4-4: SQL の SELECT 文や INSERT 文での列名の羅列の生成
SQL の SELECT 文や INSERT 文での列名の羅列の生成

次のテキストが生成されます。

item_id, name, price

設定の変更

個別設定

テンプレートごとに、フォントとパラメーター記号を変更することができます。

全体設定

編集している .tkt ファイルに含まれる、すべてのテンプレートに適用するフォントとパラメーター記号を変更することもできます。個別に設定されている場合は個別設定が優先されます。


Windows は米国 Microsoft Corporation の米国およびその他の国における登録商標です。

Microsoft .NET は、お客様、情報、システムおよびデバイスを繋ぐソフトウェアです。