メインコンテンツ

コメントを含める

生成されたコード内のコメント

説明

アプリ構成ペイン: コード外観

構成オブジェクト: coder.MexCodeConfig | coder.CodeConfig | coder.EmbeddedCodeConfig

生成ファイルにコメントを配置するかどうかを指定します。

このパラメーターを有効にした場合、コード ジェネレーターは既定のコメント (推定された引数の型など) を生成コードに配置します。また、コード ジェネレーターは、MATLAB® 関数内に配置されたコード コメントを生成されるコードにコピーします。ただし、いくつかの例外があります。たとえば、通常は、生成されるコードには内部の最適化のために削除された MATLAB 関数のコード コメントは含まれません。

ライブ関数のコード (.mlx ファイル) を生成する場合、[コメントを含める] を有効にしても、コード ジェネレーターは生成コードにテキスト セクションを含めません。生成されるコードにライブ関数のテキスト セクションをコメントとして含めるには、まず .mlx ファイルを .m ファイルとして保存します。これにより、テキスト セクションが関数本体内のコード コメントに変換されます。コード ジェネレーターは .m ファイル内の関数よりも .mlx ファイル内の関数を優先するため、いずれかの関数の名前を変更するか、いずれかのファイルを別のフォルダーに移動する必要があります。その後、.m ファイルの関数のコードを生成します。コード ジェネレーターは、生成されるコードにテキスト セクションをコメントとして含めます。

依存関係

このパラメーターを選択すると、[コメントとして MATLAB ソース コードを含める] パラメーターが有効になります。

設定

オン

コード ジェネレーターは生成コードにコメントを含めます。この値が既定値です。

オフ

コード ジェネレーターは生成コードにコメントを含めません。

プログラムでの使用

プロパティ: GenerateComments
値: true | false
既定の設定: true

バージョン履歴

R2011a で導入