EN JP CN

注釈の使用

注釈の使用

ソースクロスリファレンスで表示できるシステムモデルのエンティティに注釈を付けることができます。Klocwork Static Code Analysis では、ユーザーモデルを使用できないため、システムモデルの注釈の追加または変更だけができます。

すべてのユーザーに注釈の読み取り/書き込み権限があります。

注釈は複数の目的で役立ちます。たとえば、

  • コードについて学びながら、コードのエンティティに注釈を追加できます。これらの注釈は、ソースコードのコメントに追加すると便利です。
  • 他のソフトウェアデベロッパーに必要な変更について指示したり、自分が行った変更や行う予定の変更を知らせたりするために、コードのエンティティに注釈を追加できます。
  • システムコンポーネントについてのガイドラインを説明したり、プロジェクト計画、プレゼンテーション、仕様などの外部ドキュメントを参照する注釈を追加できます。

注釈追加のヒント

  • 同じ名前、場所、タイプの複数のエンティティがある場合 (たとえば、複数のコンストラクターや多重定義されたメソッド)、これらのエンティティの 1 つに追加された注釈は、それらすべてにアタッチされます。
  • すべての文字は許容される入力ですが、HTML タグは認識されず、注釈では型指定として表示されるだけです。
  • 長い注釈を作成することも可能ですが、関連するドキュメントにリンクする方が便利な場合があります。