目录
前言
注释层级
注释方式
注释格式
功能层(顶层):
时间计划层:
控制流层:
前言
前篇已经说到,使用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最底层,大家应该都有随手注释的习惯,这种注释就不多啰嗦啦。