為Simulink模型添加注解的方式分享和介紹

上周，我們通過(guò)下圖中的Simulink 汽車(chē)模型介紹了為 Simulink 模型添加注解的五種方式（點(diǎn)擊閱讀）其中的三種，本文將繼續(xù)演示余下的注解方法：

向模型層添加備注

為總線、信號(hào)和參數(shù)添加注解

向模型層添加備注

隨著模型越來(lái)越大，層次結(jié)構(gòu)中也添加了越來(lái)越多的層，這使得研發(fā)人員很難掌握整體情況。可以使用視圖標(biāo)簽、備注和 DocBlock 對(duì)模型的各個(gè)層進(jìn)行注解。

對(duì)部分模型打視圖標(biāo)簽書(shū)簽，您可以使用它們直接導(dǎo)航到模型的特定部分，并提供特定視圖的詳細(xì)信息或注釋。要?jiǎng)?chuàng)建視圖標(biāo)簽，可從想要捕獲的模型部分的選項(xiàng)板中選擇 Viewmark This View（標(biāo)注此視圖）按鈕。單擊 Viewmarks（視圖標(biāo)簽）按鈕，查看并向您的視圖標(biāo)簽添加描述或注釋?zhuān)▓D 7）。

圖7. 模型視圖標(biāo)簽的詳細(xì)特定視圖。

要將備注添加到模型層次結(jié)構(gòu)中的任何層，首先需要?jiǎng)?chuàng)建一個(gè)備注文件。備注可以包括圖像和鏈接，以及URL。如果模型已經(jīng)有了與之關(guān)聯(lián)的備注，則在層次結(jié)構(gòu)中導(dǎo)航時(shí)，Notes（備注）窗格將顯示當(dāng)前層的內(nèi)容（圖 8）。

圖 8. 用于詳細(xì)說(shuō)明模型層次結(jié)構(gòu)中特定層的備注。

DocBlock 為您提供了另一種添加備注的方法。雙擊模塊的某個(gè)實(shí)例，可創(chuàng)建一個(gè)包含該模塊關(guān)聯(lián)文本的臨時(shí)文件，并在編輯器中打開(kāi)該文件（圖 9）。請(qǐng)注意，可以將 DocBlock 中的注釋文本用作全局注釋?zhuān)ㄔ撟⑨岋@示在從模型生成的代碼中）。

圖9. 添加了注釋的 DocBlock。

為總線、信號(hào)和參數(shù)添加注解

Simulink 模型通常依賴(lài)于存儲(chǔ)在模型外部的變量和數(shù)據(jù)。例如，總線、信號(hào)和參數(shù)對(duì)象一般存儲(chǔ)在基本工作空間中。您可以使用對(duì)象的Description屬性詳細(xì)說(shuō)明對(duì)象的作用和功能。該功能可以通過(guò)編程實(shí)現(xiàn)：

>> myParam = Simulink.Parameter; myParam.Description = 'This is the parameter description';

也可以從相應(yīng)的對(duì)話框中通過(guò) Model Explorer（模型資源管理器）訪問(wèn)或雙擊對(duì)象來(lái)實(shí)現(xiàn)（圖10）。

圖 10. 總線、信號(hào)和參數(shù)對(duì)象的 Description(描述)字段。

如果使用 Embedded Coder從模型生成代碼，則可以將總線、信號(hào)和參數(shù)對(duì)象描述添加為生成代碼中變量聲明的注釋?zhuān)▓D11）。

圖 11. 將總線、參數(shù)和信號(hào)對(duì)象描述字段用作生成代碼中的注釋。