タグの定義方法

1、タグの定義ファイルについて
2、タグの定義方法
 2−1、タグの定義
 2−2、1つのファイルで複数のタグを定義する場合
 2−3、タグ名の規則
 2−4、プロパティの規則
3、タグの定義順序
4、タグ定義やテンプレート定義の変更手順
5、アドイン起動時に行うチェック項目



1、タグの定義ファイルについて

 タグを定義するファイル(テキストファイル)の場所と名前は決まっています。
 このアドインの使用者が修正できるタグの定義ファイルはtag_customフォルダ配下にあるファイルだけです。
 以下にファイル名と、そのファイルで定義するタグの説明を示します。

ファイル名とそのファイルで定義するタグの説明
ファイル名
説明
template.txt
 テンプレートタグである下記の2つの定義します。(必須)
   <classTemplate>、<methodTemplate>
 [ヘッダコメントの挿入]コマンドを実行すると、カーソルが(Declarations)にあった場合は<classTemplate>で 定義した内容が、そうでなければ、<methodTemplate>で定義した内容でヘッダコメントが挿入されます。
class.txt クラス(モジュール)の種類に対する別名を定義する事が出来ます。
method.txt メソッド(プロシージャ)の種類、引数の有無により挿入する文字列を定義する事が出来ます。
argList.txt argタグを使って、ある引数に対して挿入する文字列を定義する事が出来ます。
arg.txt 引数の値渡し方法の別名、ParamArrayかどうかによって挿入する文字列を定義する事が出来ます。
application.txt 何も定義しませんが、ファイルは必要です。
other.txt 現在時刻を挿入する時のフォーマットを定義する事が出来ます。

このページのトップへ



2、タグの定義方法

2−1、タグの定義

タグは下記のように定義します。
 "<" & タグ名 & ">"=プロパティ
例:
    <classKind_Ja>=ドキュメント,標準モジュール,クラスモジュール,フォーム


2−2、1つのファイルで複数のタグを定義する場合

1つのファイルで複数のタグを定義する場合は以下の例のように";"(セミコロン)で区切ります。
例:
  <methodAccessType_Ja>=パブリック,フレンド,プライベート,宣言部;
  <methodType_Ja>=メソッド,メソッド,ゲッター,セッター,セッター,宣言部;
  <argExist_String>=<br><argList>,なし<br>
※";"(セミコロン)の後で改行していますが、改行は無視されるため、あっても無くても問題ありません。


2−3、タグ名の規則

タグ名は下記の規則に従います。

2−4、プロパティの規則

プロパティは下記の規則に従います。

このページのトップへ


3、タグの定義順序

タグの定義順序はタグを定義しているファイルによって決まります。
一つのファイル内では上で定義している方が定義順序が小さくなります。

タグの定義順序と説明
順序
タグ定義ファイルの名前
定義するタグ
1
-
<br>,<tab>,<equal>,<comma>,<semicolon>
2
tag_program/other.txt
<lt>,<gt>,<today>
3
tag_custom/other.txt
<today_XXX>
4
tag_program/application.txt
<creator>,<org>
5
tag_custom/application.txt
-
6
tag_program/arg.txt
<argNumber>,<argIsParamArray>,
<argIsOptional>,<argCallType>,
<argName>,<argType>,<argDefaultValue>
7
tag_custom/arg.txt
<argIsParamArray_XXX>,
<argIsOptional_XXX>,<argCallType_XXX>
8
tag_program/argList.txt
<argList>
9
tag_custom/argList.txt
<argList_XXX>
10
tag_program/method.txt
<methodIsStatic>,<methodAccessType>,
<methodType>,<methodName>,
<methodReturnType>,
<argExist>,<argCount>
11
tag_custom/method.txt
<methodIsStatic_XXX>,
<methodAccessType_XXX>,
<methodType_XXX>,<argExist_XXX>
12
tag_program/class.txt
<className>,<classKind>
13
tag_custom/class.txt
<classKind_XXX>
14
tag_custom/template.txt
<classTemplate>,<methodTemplate>
※1:XXXは任意の文字列を表します。

このページのトップへ


4、タグ定義やテンプレート定義の変更手順

下のアクティビティ図(もどき)を見て下さい。

タグ、テンプレート定義の変更手順
タグ・テンプレート変更手順

凡例
タグテンプレート変更手順の凡例
このページのトップへ

5、アドイン起動時に行うチェック項目

アドイン起動時にタグについて下の表に書いたチェックを行います。
エラーを起こした場合、次のようなVB標準のエラー画面が表示されますので、[終了]ボタンを押して下さい。

エラーを起こした場合に表示されるダイアログ
エラー画面

エラーチェック項目
項番
内容
チェックタイミング
備考
1
タグ・テンプレート定義ファイルがあるか
ファイルから文字列(タグ)を読込むとき
utlIHCTagクラスの
loadTagDifListメソッド
2
タグ定義が規則に従っているか
文字列からタグ情報を取得するとき
utlIHCCheckクラスの
checkTagDifStringメソッド
3
タグの種類が正しいか
文字列からタグ情報を取得するとき clsIHC*Tagクラスの
initializeInstanceメソッド
4
プロパティでカンマの数が正しいか
文字列からタグ情報を取得するとき clsIHC*Tagクラスの
initializeInstanceメソッド
5
タグの種類がtodayのとき、
プロパティが不正でないか
文字列からタグ情報を取得するとき utlIHCCheckクラスの
checkTodayTagPropメソッド
6
同名のタグを2回定義していないか
文字列からタグ情報を取得したあと clsIHCTagListクラス、
clsIHCTemplateTagListクラスの
loadInstanceメソッド
7
template.txtに
classTemplate、methodTemplateタグが定義されているか
すべてのタグを読込んだ後
utlIHCCheckクラスの
checkTemplateTagListメソッド
8
定義されていないタグを使用していないか
自分より定義順序がおおきいタグを使用していないか
すべてのタグを読込んだ後 utlIHCCheckクラスの
checkUseUndefinedTagメソッド
9
arg.txtで定義したタグを
art.txtとargList.txt以外で使用していないか
すべてのタグを読込んだ後 utlIHCCheckクラスの
checkPlaceOfTheArgTagメソッド

このページのトップへ