В следующих разделах описывается, как использовать ПО HDL Coder™ для добавления текстовых аннотаций в созданный код в виде аннотаций модели, текстовых комментариев или комментариев к требованиям.
Текст можно ввести непосредственно на блок-схеме как аннотации Simulink ®. Кодер HDL визуализирует текст из аннотаций Simulink как комментарии к простому тексту в сгенерированном коде. Комментарии создаются на том же уровне иерархии модели, что и подсистемы, содержащие аннотации, как если бы они были блоками Simulink.
Для постоянных блоков, чтобы отразить аннотации как комментарии в коде HDL, снимите флажок Минимизировать промежуточные сигналы (Minimize intermediate signals) и установите для параметра Стиль отслеживания (Traceability style) значение Comment Based.
Общие сведения об аннотациях см. в разделе Описание моделей с использованием заметок и аннотаций.
Можно предоставить описание сигналов в модели Simulink. Сгенерированный код HDL отображает эти описания в виде комментариев над инструкциями объявления сигнала. Чтобы указать описание сигнала, щелкните его правой кнопкой мыши и выберите Свойства (Properties), чтобы открыть диалоговое окно Свойства сигнала (Signal Properties). Затем перейдите на вкладку Documentation и в разделе Description введите описание сигнала. Для описания сигнала используйте символы ASCII, так как символы, не являющиеся символами ASCII в сгенерированном коде, могут потенциально мешать нисходящему синтезу и инструментам lint. В некоторых случаях из-за определенных оптимизаций, которые действуют на сигналы, сгенерированный код может не преобразовывать все описания сигналов в комментарии ЛПВП или может создавать реплики комментариев ЛПВП для определенных описаний сигналов.
Текстовые комментарии можно вводить на любом уровне модели, размещая DocBlock на требуемом уровне и вводя текстовые комментарии. HDL Coder визуализирует текст из DocBlock в сгенерированном коде как комментарии к простому тексту. Комментарии создаются на том же уровне иерархии модели, что и подсистема, содержащая DocBlock.
Установите для параметра Тип документа DocBlock значение Text. Кодер HDL не поддерживает HTML или RTF варианты.
Общие сведения о DocBlock см. в разделе DocBlock.
Можно присвоить блокам комментарии к требованиям.
Если модель включает комментарии к требованиям, можно выбрать визуализацию комментариев в одном из следующих форматов.
Текстовые комментарии в сгенерированном коде: чтобы включить требования в качестве текстовых комментариев в код, используйте значения по умолчанию для Включить требования в комментарии блока (on) и Создать отчет об отслеживании (off) в диалоговом окне Параметры конфигурации (Configuration Parameters).
При создании кода из командной строки установите Traceability и RequirementComments свойства. Этот код показывает текстовые комментарии требований, сгенерированные для блока усиления из mcombo модель:
open_system('mcombo') makehdl(gcb,'Traceability','off','RequirementComments','on');
BEGIN
In1_signed <= signed(In1);
--
-- Block requirements for <S10>/Gain
-- 1. Gain Requirements Sect 1
-- 2. Gain Requirements Sect 2
Gain_gainparam <= to_signed(16384, 16);
Gain_out1 <= resize(In1_signed(15 DOWNTO 0) & '0'
Out1 <= std_logic_vector(Gain_out1);
END rtl;
Комментарии по гиперссылкам: чтобы включить комментарии по требованиям в качестве комментариев по гиперссылкам в отчет о создании HTML-кода, выберите в диалоговом окне Параметры конфигурации (Configuration Parameters) пункт Создать отчет по отслеживаемости (Generate traceability report) и Включить требования в комментарии по блокам (Include requirements in block comments).
При создании кода из командной строки установите Traceability и RequirementComments свойства:
makehdl(gcb,'Traceability','on','RequirementComments','on');
Комментарии содержат ссылки на документ требований, связанный с блоком и блоком в исходной модели. Например, на следующем рисунке показаны две связи требований, назначенные блоку усиления. Ссылки указывают на разделы текстового файла требований.
Следующий код показывает комментарии к требованиям по гиперссылке, сгенерированные для блока усиления.
BEGIN
In1_signed <= signed(In1);
-- <S10>/Gain
--
--
-- Block requirements for <S10>/Gain
-- 1. Gain Requirements Sect 1
-- 2. Gain Requirements Sect 2
Gain_gainparam <= to_signed(16384, 16);
Gain_out1 <= resize(In1_signed(15 DOWNTO 0) & '0'
Out1 <= std_logic_vector(Gain_out1);
END rtl;