UnderstandのVisual Studio Code(以下VSCode)拡張機能がリリースされました。これはUnderstand 6.5以降(日本語正式版は6.3が最新です)をお使いの場合に利用可能な拡張機能となっています。普段VSCodeを使用して開発を行っている方にとって多くのメリットがあります。
Understand 6.5の試用につきましては、この記事のさいごをご覧ください。
機能
以下のUnderstandの機能がVSCode上で使用可能となります。開発中に役立つ機能が盛り込まれています。
- 解析機能(すべて解析、変更されたファイルのみ解析)
- Understandへのジャンプ機能(Understand画面へジャンプして、選択テキストの場所を表示)
- 解析エラー確認、エラー行へのジャンプ機能
- 定義、宣言箇所へのジャンプ機能、ピーク機能
使用方法
使い方について簡単に説明します。
準備
・VSCodeの拡張機能マーケットプレースで「understand」と検索していただくとトップに表示されます。まずはこちらをインストールしてください。
・Understandのインストールフォルダー内のバイナリフォルダーへの環境変数も設定してください。VSCodeの拡張機能では、userverというUnderstandの言語サーバーを起動しますが、その際にこのパスが通っていないと起動できません。
コマンド例
● Windows
export PATH=”C:\Program Files\SciTools\bin\pc-win64:$PATH”
● Linux
sudo ln -s /home/user/SciTools/bin/pc-linux64 /usr/bin
起動方法
インストール後はUnderstandのプロジェクト(.und)を含むソースコードのあるフォルダーを開きます。フォルダー内にプロジェクトがあることを検知すると、自動的に拡張機能がアクティブになります。画面左下にUnderstandのマークがでます。
正しく動作している状態
エラーの状態
エラーの状態のときは、言語サーバー(userver)が起動していないなどの原因がありますので、確認してください。
プロジェクトが別の場所にある場合
プロジェクトの作成方法によってはソースフォルダー外にUnderstandのプロジェクトを作成している場合もあります。
その場合、設定画面よりunderstandで検索して、「Project Paths」にUnderstandプロジェクトへのパスを設定してください。
解析機能
Understandで行っている解析機能がそのまま利用できます。画面左下のUnderstandマークにマウスを置くと、メニューが表示されます。その中の「Analyze all files」または「Analyze changed files 」を選択することで、解析をかけることができます。
Understandへのジャンプ機能
Understand画面へジャンプすることができます。ソースコード上のクラス、関数、変数などを選択すると、画面に電球マークが表示されるので、クリックして「Explore in Understand」を選択すると、Understand GUIが起動し、選択したエンティティがソースファイル上で選択された状態で表示されます。情報ブラウザーやグラフィカルビュー、メトリクスなどについても、「同期」にチェックがある場合は連動して該当エンティティの情報を表示します。
解析エラー確認、エラー行へのジャンプ機能
解析エラーや警告を一覧表示します。行をクリックするだけで該当のソース行にジャンプすることができます。開発中に修正したコードに問題がないかチェックする用途に使えます。
定義、宣言箇所へのジャンプ機能、ピーク機能
選択した関数などから宣言や定義の場所へジャンプ、ピーク表示(開いているソースコード上に埋め込む形での表示)ができます。拡張機能「C/C++」と同等の機能です。
さいごに
機能の概要を紹介しましたが、その他の機能など詳細に関しては拡張機能のREADMEを確認してください。英語になりますが、動画もありますので参考になるかと思います。
また、今回紹介しました機能は、Understand 6.5アルファ版で試用できます。
お試しになりたい方は、こちらより必要事項をご記入の上ダウンロードください。
Understand 6.5 アルファ版のお申込みはこちら
VSCode拡張機能の強化を含む機能改善に役立てたいと考えていますので、アンケートのご協力をお願いします。(3分程度)
ご利用アンケートはこちら
■アルファ版ご利用について
- アルファ版では、搭載予定の新機能を、正式リリース前にお試しいただけます。
- アルファ版は、動作テストを主な目的として公開しているものであり、製品に関する不具合などのお問い合わせ、技術的なサポートは対応できませんのでご了承ください。
- アルファ版は、現在も開発途中のものであり、動作が不安定な場合や、不具合などが発生する可能性もあります。
- アルファ版に搭載されている機能について、正式版では動作が変更されている、あるいは、機能自体が削除される可能性もあります。
- アルファ版の使用により発生した問題に対して、弊社は一切責任を負いません。本番環境での利用を検討されている方は、正式版のリリースをお待ちいただくことをお勧めいたします。
■ライセンス制約について
- Understand 6.xがインストールされていないマシンで利用する場合は、評価ライセンスをご請求いただけます。
- Understand 6.x正式ライセンスをお持ちでない場合は、評価ライセンスをご請求いただけます。
- 本番環境で利用する場合、Understand 6.x正式ライセンスの保守期限日(※)が 2024年9月27日以降の日付の場合、お持ちのライセンスでご利用いただけます。評価期限はありません。
※保守期限日はライセンス体系によって確認項目が異なります。
・買取ライセンス:保守有効期限日(Maintenance)
・年間ライセンス:有効期限日(Expiration)
■インストール時の注意事項
- Understand 6.3、6.0、5.1などのバージョンがインストールされている環境でも利用可能です。同一マシンで他のUnderstandバージョンも利用している場合は、異なるインストール先フォルダーを設定してください。
■制限事項
- VSCodeとUnderstandは同時に起動している場合に解析ができません。VSCode上でUnderstand拡張機能が起動している状態、かつ、Understandが起動している状態(und コマンドラインの実行を含む)の場合、VSCode、Understandのいずれからも解析ができなくなります。解析を実施する際は、他方のアプリケーションを停止してから行うようにしてください。
- アルファ版は、Understand 6.0以下のバージョンと同時に起動することはできません。
■サポートプラットフォーム
Windows 10.1809以降
Linux 64bit (CentOS/RHEL 8.4以降、およびUbuntu 20.04 以降)