Description
Description-Separate-1このガイドラインはサンプルコードを作成する上でのベストプラクティスを説明します。
サンプルコードを投稿する際は、以下に示す項目について注意するようにしましょう。
特に、青文字で記載されている項目については添付の「Community Example VI Analyzer tests」を用いて、
条件を満たしているかどうかテストすることができます。
「Community Example VI Analyzer tests」の使用方法については、
「Example-Programs-VI-Analyzer-Test-Suite-Instructions.pdf」をご確認ください。
なお、このスタイルガイドは以下の英語のスタイルガイドラインに基づき作成されています。
Example Programs Style Guidelines - Discussion Forums - National Instruments
http://forums.ni.com/t5/Using-the-NI-Community/Example-Programs-Style-Guidelines/td-p/3368050
ファイル名
- サンプルで実装している機能を端的に表すファイル名にしましょう。また、ファイル名に英語を使用する場合は、単語を省略せずに単語間を半角スペースで区切るようにしましょう。
- 悪い例: GenericRTControl.lvproj, AppManagement.lvlib, ExitAllOnErr.vi
- 良い例: Generic Real-Time Control.lvproj, Application Management.lvlib, Exit All On Error.vi
アイコンコネクターペーン
- 理由がない限り、全てのVIが4x2x2x4のコネクターペーンを持つようにしましょう。
- サブVIのアイコンは、サブVIの機能を表現しているものにしましょう。
フロントパネル
- 下記の項目に関するフリーラベルを、フロントパネルの左上に追加しましょう。
ただし、既にコミュニティページ側に下記の項目の記載がある場合は、
こちらの作業は省略可能です。
【フリーラベル作成メモ】
- サンプルコードの簡潔な概要を記してください。
より詳細なプログラムの内容に関しては別途コミュニティページに
記載するようにしてください。
- セクション名は太字にしてください。（概要、要件、操作手順等）
- 要件の項目には、「～と互換性があるバージョン」「～バージョン以降」というように
今後も使うことができることを明記しましょう。
【フリーラベル例】
概要：このVIでは◯◯の使用方法についてデモンストレートします
要件：LabVIEW 2012以降
操作手順：
1. VIを実行してください
2. （以下、必要な操作を記述）
- 理由がない限り、全ての制御器、表示器のラベルは表示させましょう。
ブロックダイアグラム
- 全てのVIに対してパスワードで保護しないようにしましょう。
- なるべくwhileループによるポーリングは避け、イベントストラクチャを使用しましょう。
- 制御器に対し、値変更イベントを構成した場合、イベントケース内に制御器を配置しましょう。
- コードが複数ループを含み、且つキューメッセージハンドラなどのデザインパターンに
則ったものでない場合、右下に以下のようなフリーラベルを追加してください。
「メモ: 通常、大規模なLabVIEWアプリケーションで並列ループを停止するには、
より高度なメカニズムが必要です。このようなアーキテクチャの例を参照するには、
ファイル→プロジェクトを作成ダイアログからキューメッセージハンドラプロジェクトを作成します。 」
- メインVIの実行ボタンが壊れることが想定される場合は、
コミュニティページにVIを添付する代わりに、VIスニペットを含めてください。
VIスニペットに関してはチュートリアルをご参照ください。
- 全てのVIに対して自動エラー処理を無効にするようにしましょう。
ブロックダイアグラム中のすべてのエラーノードにエラーワイヤを配線するようにして、
その最後にはシンプルエラー処理.viを設置するようにしましょう。
- フィードバックノードを使用していない限り、右から左向きのワイヤは作成しないでください。
- ストラクチャやブロックダイアグラムのノードに隠れたワイヤは作成しないでください。
- デフォルト値を含むクラスタ定数には「クラスタをアイコンとして表示」を選択してください。
- サンプルコード内に自身で作成したクラスタ、または列挙体が含まれる場合、
タイプ定義をしてください。
- サンプル内にもう使用されていない、もしくは非推奨のVI、プロパティ、メソッドが
含まれないようにしましょう。
- 決してスタックシーケンスストラクチャを使用しないようにしましょう。
- サブダイアグラムラベルを活用しましょう。
- 長いワイヤにはラベルを追加しましょう。
その他
- 全てのVI（サブVIも含む）に対してVIプロパティにてデバッグを許可してください。
- 全てのVIに対してVIプロパティのウィンドウの概観が「デフォルト」に設定されていることを
確認ください。
- 1つ以上のVIをサンプルコードに含む場合、全ての必要なVIをzipファイル形式でまとめてください。
- その他サンプルデータ、画像、音声ファイル、構成ファイル等のサンプルプログラムの実行に
必要なファイルを含めてください。
- VIスニペットを作成し、画像として挿入ください。
- LabVIEWのバージョンをダウンロードファイル名に含めてください。
例：「My Custom Sorting Algorithm – LV2009.vi」「My Custom Sorting Algorithm – LV2009.zip」
- LabVIEWライフサイクルポリシーに則り、旧バージョン用に保存し、3バージョン前のVIも添付してください。
LabVIEW2016を使用中ならば、LabVIEW2013のバージョン（添付必須）と
LabVIEW2016のバージョン（添付任意）を添付してください。
Description-Separate-2
