前言

前篇已经说到，使用Matlab的print功能导出模型详细设计，相关的配置。若想生成的详细设计内容完整，格式清晰有条理，就需在模型的注释上下功夫。这次来分享一下在这方面的一些经验。

在分享注释之前，需要了解对于一份完整的详细设计，需要含有哪些内容，能符合ASPICE对详细设计的要求。大家自己去研究下ASPICE的SWE3的相关BP哈，与之前分享的代码导出详设相同，这里不再赘述。

首先，模型中有很多种注释的方式，当然，不是每一种都能显示在print导出的详细设计中。大家可以自己尝试注释，然后看下在print导出的详设中显示的情况。本文推荐的均为当前我觉得最合适的在详设中看起来最舒服的方式。

注释层级

对建模及建模规范有了解的朋友应该知道，从模型架构层面，模型大致分为功能层、时间计划层、控制流层、数据流层。

从一般符合AUTOSAR开发来说，模型基本按功能划分为组件SWC，在ASPICE中，一个组件对应一份软件详细设计。从开发来说，一个组件对应一个模块。则在这个功能组件的最外层，即功能层，也叫顶层；时间计划层根据组件内单元的时序不同进行设计，有的组件中没有；控制流层可以当作单元之间交互层；数据流层即模型最里层，单元的内部逻辑。

为了完整性，对每一层都通过注释形式进行详细设计描述。

注释方式

所有模型层级的注释方式，推荐如下：

1、在最外层模型界面上，打开property inspector工具

2、property inspector工具会在界面右侧显示

3、在discription中进行如下推荐格式的注释

注释格式

功能层（顶层）：

Model Version: 1.0

Modified History:

V1.0 初版

V1.1 （变更点）

SW component SWC001: （组件名）

Detail:（组件功能语言描述）

Ref SW Component ID: (组件追溯的软件架构ID)

时间计划层：

Detail:（时序、周期语言描述）

控制流层：

Unit ID: SWU_001（软件单元ID）

Unit Name: （单元名）

Brief: （简要描述单元功能）

Ref SW Requirement ID:（单元追溯的软件需求ID）

数据流层：

Unit ID：SWU_001（软件单元ID）

Unit Name：（单元名）

Detail:（详细描述单元内部逻辑）

Note:（其他说明）

当然，上述注释均是为了显示在导出的详细设计上。在simulink及stateflow最底层，大家应该都有随手注释的习惯，这种注释就不多啰嗦啦。

ASPICE SWE3之——模型生成软件详细设计2 注释格式相关推荐

ASPICE SWE3之——模型生成软件详细设计1 配置
目录 1.导出模型软件详细设计的配置: 2.导出的详细设计报告的内容: 前言同C代码通过工具生成软件详细设计,模型开发也可通过工具导出详细设计. MATLAB有单独用于生成软件详细设计的工具包Sim ...
ASPICE SWE3之——C代码生成软件详细设计2 注释格式
写软件详细设计文档,一般多为有ASPICE要求,写文档真的很费时间,没有要求真的不想写. Doxygen工具就提供了一种通过给代码注释的方式,导出详细设计文档,至于导出什么内容,主要取决于注释的内容. ...
ASPICE SWE3之——C代码生成软件详细设计1 Doxygen配置
目录 1 前言 2 Doxygen简介 2.1 什么是Doxygen 2.2 安装Doxygen及辅助软件 2.3 Doxygen的配置 1 前言前面已经单独一篇文章讲了,若想通过Doxygen工具 ...
【昇腾学院】昇腾AI处理器软件栈--框架管理器（Framework）离线模型生成
离线模型生成以卷积神经网络为例,在深度学习框架下构造好相应的网络模型,并且训练好原始数据,再通过离线模型生成器进行算子调度优化.权重数据重排和压缩.内存优化等,最终生成调优好的离线模型.离线模型生成 ...
软件工程，开发模型，软件开发流程
软件工程 (Software Engineering,简称为SE)是一门研究用工程化方法构建和维护有效的.实用的和高质量的软件的学科.它涉及到程序设计语言,数据库,软件开发工具,系统平台,标准,设计模 ...
软件详细设计说明书_软件测试的基本理论笔记
一.开发与测试流程理论 ##1.软件开发阶段划分 ###需求分析根据客户的要求,清楚了解客户需求中的产品功能.性能.界面和具体规格等,然后进行分析,确定软件产品所要达到的目标. 需求规格说明书 ## ...
unity非常好用的路径生成软件 unity3d Curvy Splines 8[8.2.1]
unity非常好用的路径生成软件让 Unity 样条线的处理回归本真!Curvy 经历了实战考验,它能为你的游戏提供一流的 UI,简单快速!顶尖的样条线编辑功能(线性.贝塞尔曲线.卡特姆.TCB) ...
如何在语音字幕生成软件 “字幕助手“ 中配置使用有道ASR引擎
随着科技进步.信息技术和交通运输方面取得的发展,现在世界上不同种族.不同国家.不同语言的人之间交流越来越方便了.在视频这个领域,外文的需求也越来越强烈了. 字幕助手是一款根据音频自动识别生成字幕的辅助 ...
医学图像与生物模型处理软件MedSys1.0
医学图像与生物模型处理软件 (MedSys 1.0beta版) 2011.4.21 qq群:146743497 中国科学院深圳先进技术研究院 2 医学图像与生物模型处理软件MedSys ...

ASPICE SWE3之——模型生成软件详细设计2 注释格式

前言