Understand 3.0 の新機能 -アノテーションについて紹介します。
アノテーションは、ソースコードに変更を加えることなく、任意のエンティティに対してUnderstand上で表示されるコメントを付ける機能です。
以下は、アノテーション機能でmainエンティティとargvエンティティにコメントを付けた画像です。
アノテーションは、任意のエンティティ上で、右クリック-[アノテーション]-[○○にアノテーションの追加/編集]をクリックして追加/編集が行えます。
アノテーションのメニューには、[フィルター]・[検索]・[孤立アノテーションの管理]の3つのサブメニューがあります。
フィルター
アノテーションは、文頭に#key:valueと記述できます。keyはタグ名、valueは値(マルチバイト可)を入れます。
[フィルター]ではタグ(key)を指定し、そのタグの値(value)でフィルタリングできます。
以下の画像では、keyに[メイン関数]、valueに[任意のコメント]が付けられているアノテーションのみを表示しているため、前の画像の “char *argv[]” に付けているアノテーションは表示されません。
検索
検索は、アノテーションの編集日時やタグを指定し、プロジェクト全体に付けられているアノテーションを検索する機能です。
以下の画像では、mainエンティティに付けられている[#メイン関数:任意のコメント]と、argvエンティティに付けられている[#char型の変数:argvへのコメント]の2つのアノテーションが検索結果として表示されています。
孤立アノテーションの管理
孤立アノテーションの管理では、エンティティに関連付いていないアノテーションを、該当するエンティティと関連付けることができます。
以下画像の左側でアノテーションを選択し、右側で関連付いているエンティティを設定できます。
アノテーションは、ソースコードを直接変更することなく、レビュー結果等を記述できます。また、タグを使い優先度や担当者などを設定することで、すぐに修正すべきものだけを検索し、コメントを確認できます。
