最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

DocBlock

モデルを記述するテキストを作成して、モデルと共にテキストを保存

  • ライブラリ:
  • Simulink / Model-Wide Utilities

    HDL Coder / Model-Wide Utilities

説明

DocBlock によって、モデルを記述するテキストの作成と編集ができ、そのテキストをモデルと共に保存することができます。このブロックのインスタンスをダブルクリックすると、このブロックに関連付けられたテキストを含む一時ファイルが作成されて、テキスト エディターにファイルが開きます。エディターを使用してテキストを変更し、保存します。Simulink® では、保存されたファイルの内容をモデル ファイルに格納します。

DocBlock は、HTML、Rich Text Format (RTF)、ASCII テキスト ドキュメント タイプをサポートします。これらのドキュメント タイプの既定のエディターは、以下のとおりです。

  • HTML - Microsoft® Word (利用可能な場合)。そうでない場合、DocBlock は [設定] ダイアログ ボックスの [エディター/デバッガー] ペインで指定したエディターを利用して HTML ドキュメントを開きます。

  • RTF - Microsoft Word (利用可能な場合)。そうでない場合、DocBlock は [設定] ダイアログ ボックスの [エディター/デバッガー] ペインで指定したエディターを利用して RTF ドキュメントを開きます。

  • テキスト - DocBlock は [設定] ダイアログ ボックスの [エディター/デバッガー] ペインで指定したエディターを使用してテキスト ドキュメントを開きます。

既定のエディターを変更する場合は、docblock コマンドを使用します。

ヒント

DocBlock のブロック パラメーターを編集するには、ブロック アイコンを右クリックし、[マスク]、[マスク パラメーター] を選択します。

パラメーター

すべて展開する

このフィールドに、テンプレートの記号名を入力します。Embedded Coder® は、モデルから生成されるコードに、この記号を使ってコメントを追加します。詳細については、Add Global Comments in the Generated Code (Embedded Coder)を参照してください。

依存関係

生成コードにコメントが表示されるようにするには、さらに [ドキュメント タイプ][テキスト] に設定しなければなりません。

プログラムでの使用

ブロック パラメーター: ECoderFlag
型: 文字ベクトル
値: Abstract | Description | History | Modified History | Notes
既定の設定: '0'

DocBlock に関連するドキュメントのタイプを選択します。次のオプションがあります。

  • テキスト

  • RTF

  • HTML

依存関係

コード生成中にコメントを追加するために DocBlock を使用している場合、[ドキュメント タイプ] を必ず [テキスト] に設定してください。[ドキュメント タイプ][RTF][HTML] に設定した場合、コメントがコード内に表示されなくなります。

プログラムでの使用

ブロック パラメーター: DocumentType
型: 文字ベクトル
値: Text | RTF | HTML
既定の設定: 'Text'

ブロックの特性

データ型

直接フィードスルー

いいえ

多次元信号

いいえ

可変サイズの信号

いいえ

ゼロクロッシング検出

いいえ

拡張機能

PLC コード生成
Simulink® PLC Coder™ を使用して構造化テキスト コードを生成します。

R2006a より前に導入