説明コメント

計算機の言語

実験のテスト環境として、計算機のチュートリアル言語を選択しました。電卓チュートリアルプロジェクトは、MPS ディストリビューションに付属するサンプルプロジェクトセットに含まれています。先に進む前に、チュートリアルに目を通して言語に慣れておくことをお勧めします。

フィールドへの変更

入力フィールドと出力フィールドに説明的なコメントを追加するための機構の構築を始めましょう。私たちのアプローチは、生成されたコードだけでなくノードに追加されたときにそれらの外観に影響を与えるアノテーションに基づいています。私たちの望む機能を可能にするいくつかの重要な要素があります。

• どのノードが説明コメントを保持できるかを示すマーカーインターフェース

• ノードが説明コメントを保持しているかどうか、および説明が何であるかを示すためのアノテーション自体

• キャレット配下のノードに説明コメントをすばやく追加および削除するためのキーボードショートカットを提供するアクション

• 記述されたコンポーネントの視覚的な「ツールチップ」を生成するためにコード生成プロセスを更新する

すべてのコメント可能なノードをマークするための新しいインターフェースから始めます。

ここで、InputField と OutputField の両方の概念で、新しい ICanHaveDescription インターフェースを実装する必要があります。

DescriptionAnnotation のコンセプト

まだパズルの核心となるピース、つまり入力フィールドと出力フィールドに割り当てられる説明コメントを指定するための実際のアノテーションが欠落しています。さっそく作成しましょう。

コンセプトに NodeAttribute を拡張させると、MPS は、属性の詳細を示す詳細情報を提供するようにヒントを提供します。Alt+Enter を介してクイックフィックスを呼び出すと、カスタマイズに必要な情報が追加されます。

ロールと属性付きの概念の値を設定して、新しいアノテーションの追加の品質を指定する必要があります。アノテーションのロール を descriptionComment として設定します。これは、ノードに DescriptionAnnotation のアノテーションが付けられているかどうかを確認するために、クエリで使用する名前です。また、アノテーションは ICanHaveDescription を実装するノード（この場合は InputField と OutputField）に のみ帰属できることも示しています。

DescriptionAnnotation には、説明の実際のテキストも保存する必要があります。これには、文字列プロパティ descriptionText を使用します。

DescriptionAnnotation のエディターは、説明コメントが添付されたノードの視覚的な動作を定義する重要な要素です。アノテーションが付けられたノードの先頭に「described」定数を追加し、括弧で囲まれた実際の説明テキストを追加します。属性付きノードセルは、属性が添付されているノードである実際のノードのエディターを表します。

さらなるエディターの機能強化

ノードの説明コメントのオンとオフを切り替えるために、新しい KeyMap を作成します。

コードを編集するには、BaseLanguage と smodel の概念を使用します。これらは、デフォルトで使用可能になっているはずです。そうでない場合は、Ctrl+L を介してインポートします。初期化されたノードを簡単に作成するために、アクション言語も必要になります。これはおそらく明示的にインポートする必要があります（Control + L）。

これでアクションを完了できます。

ICanHaveDescription を実装しているノードで Control + Alt + Shift + D を押すと、アクションはノードとの間で DescriptionAnnotation を追加または削除します。

KeyMap は、Control + Alt + Shift + D に反応する必要があるすべてのフィールドに追加する必要があります。この場合、これは InputField と OutputField に対するものです。Control + Alt + Shift + D キーの組み合わせに反応するエディターセルには、keycap プロパティで指定されたキーマップが必要です。

これまでどのようにしていますか？

コンパイル後、入力フィールドと出力フィールドの両方で Control + Alt + Shift + D を使用して、説明コメントを切り替えることができます。

ジェネレーターを更新する

現在、DescriptionAnnotation は生成プロセス中に失われます。代わりに、コメント化された入力フィールドと出力フィールドを表すテキストフィールドの Swing「ツールチップ」を生成したいと考えています。

コード生成時、現在では電卓内のすべての入力フィールドまたは出力フィールドを取得し、それらに対応する JTextField を生成します。コンストラクターでは、生成された各 JTextField の初期化コードも生成します。この場所で、入力フィールドまたは出力フィールドを表す JTextField に説明コメント付きの Swing 「ツールチップ」を添付できます。

$IF$ ノードマクロは、DescriptionComment アノテーションが添付されたノードに対してのみ「ツールチップ」が生成されるようにします。

「ツールチップ」のテキストのプロパティマクロは、現在のノードに添付されている DescriptionAnnotation の descriptionText を設定します。

言語とサンドボックスソリューションを再構築すると、生成された Calculator フォームには、DescriptionAnnotation でマークされたフィールドに「ツールヒント」が添付されます。

要約

ここでツアーを終了できます。入力フィールドと出力フィールドは両方とも、DescriptionAnnotation で記述でき、生成されたコードには、それぞれの記述の「ツールヒント」が含まれます。