LabVIEWのコーディングにおけるベストプラクティスは何ですか？

問題

• LabVIEWのコーディングにおけるベストプラクティスはどこで入手できますか？コードが複雑になってきたので、正しい方法でコーディングできているか確認したいです。
• 私はLabVIEWを使い始めたばかりで、コードが非効率的です。コードを改善するにはどのような方法がありますか？

解決策

LabVIEWコードを開発する際には、コードの複雑さや目的に応じて、考慮すべき多くのガイドラインが存在します。

以下のリストは、完全なリストではないものの、最も一般的で初心者にも分かりやすい考慮事項の概要を示したものです。

• LabVIEWコードでは、可能な限りエラーワイヤを使用して実行フローを制御してください。
• 実行フローは可能な限り左から右にする必要があります（逆方向の配線や上から下へのフローは避けてください）。
• ブロックダイアグラム上のワイヤ配線に不必要な曲がりが生じないようにしてください。
  • キーボードショートカット<Ctrl>+<U>を使用すると、選択したオブジェクト/ワイヤーをすばやく整理できます。
  • VI全体に対してダイアグラム整理のためのクリーンアップのショートカットを使用することは避けてください。
• アプリケーションはデザインパターンに準拠する必要があります。最適なデザインパターンはコードの複雑さによって異なりますが、一般的なアーキテクチャには以下のようなものがあります。
  • ステートマシン
  • 生産者／消費者
  • キューメッセージハンドラー (QMH)
  • Delacor キューメッセージハンドラー (DQMH)
  • オブジェクト指向プログラミング（OOP）
  • アクターフレームワーク（AF）
• ローカル変数と グローバル変数は、どうしても必要な場合を除き、使用を避けるべきです。
  • 代わりに、制御器または表示器をブロックダイアグラムの端子に直接配線するか、機能的グローバル変数（FGV）を使用してください。
  • 詳細については、 ローカル変数とグローバル変数を慎重に使用するを参照してください。
• ケースストラクチャを使用する場合は、デフォルトケースを定義してください。
• UIからのイベントを監視するには、ポーリングではなくイベントストラクチャを使用してください。
• シーケンスストラクチャは、どうしても必要な場合を除き、使用を避けてください。詳細については、 シーケンスストラクチャを使用するかを決定するを参照してください。
  • 実行フローを強制する必要がある場合は、エラーワイヤを使用してください。
• ブロックダイアグラムは、スクロールする必要なくモニター画面内に収まるようにしてください。
  • ブロックダイアグラムが大きくなる場合は、サブVIの使用を検討してください。詳細についてはLabVIEWサブVIを作成および構成するを参照してください。
• ブロックダイアグラム上でコードの重複を避けてください。重複するコードは、サブVIとしてまとめることを検討してください。
• 未使用のコードは避けてください。
  • 常にダイアグラム無効ストラクチャを削除し、コードを簡潔かつ明瞭に保つようにしてください。
• フロントパネルはモニター画面内に収まる必要があります。
• フロントパネルは論理的に構成され、制御器と表示器はコネクタペーン上の端子構造に対応するようにしてください。
• コネクタペーンでは、16個を超える端子を使用しないでください。
• すべてのVIに意味のあるアイコンを作成してください。アイコンは以下の条件を満たす必要があります。
  • 標準の32×32ピクセルサイズを使用してください。
  • 可能な限り、組み込みのグリフを使用してください。
  • 標準のテキスト設定を使用してください。
  • バナー内のテキストは1行に制限してください。
  • 前面の色と背景色のコントラストがはっきりしていることを確認してください。
  • ミニマリズムを優先する - VIの目的を伝えるために、可能な限り少ないグリフとテキストを使用してください。
• VIは十分に文書化されるように、ブロックダイアグラム上のフリーラベルやVIプロパティウィンドウの説明を活用してください。
• 複数の場所で使用されるカスタムのデータ型は、 タイプ定義に変換することを検討してください。
• VIアナライザを使用して、コードの品質と可読性を評価してください。
• LabVIEWプロジェクトファイルは、ディスク上のファイル階層を反映するようにしてください。
• LabVIEWファイルは、ディスク上で以下のように整理するようにしてください。詳細については、 プロジェクトエクスプローラでNI LabVIEWアプリケーションを管理する際のベストプラクティスを参照してください。
  • すべてのファイルは単一のルートディレクトリ内に配置する。
  • アプリケーションを管理可能な論理単位に分割する。
  • 分かりやすい命名規則を使用する。
  • 最上位のVIを他のソースコードから分離する。

追加情報

より詳細かつ具体的なガイドラインについては、下記の関連リンクを参照してください。