AUTOSAR-软件规范文档阅读

基于AUTOSAR_SWS_CANDriver.pdf,Specification of CAN Driver AUTOSAR CP Release 4.3.1

AUTOSAR所有软件规范文档(SWS)的目录结构都是一样的,如下:

特点及优点如下:

a. 结构化程度高,所有文档结构一致,易于查找;

b. 内容详实,包括所有API/数据结构的列表;

c. 采用多种说明方法,如表格、UML图,易于理解。

1 Introduction and functional overview

第一章做简单的功能介绍。

5 Dependencies to other modules

第五章介绍该模块与其他模块之间的依赖关系

这里主要看与头文件结构,从中我们可以看到模块设计的头文件、代码文件,以及各文件之间的引用关系。

7 Functional specification

第7章对该模块功能做详细、正式的说明:

8 API specification

第8章介绍该模块所涉及的数据类型、API的定义规范。

8.1 Imported types

引用到的数据类型:

8.2 Type definitions

本模块定义的数据类型:

8.3 Function definitions

本模块定义的API接口,例如:

8.4 Call-back notifications

回调函数定义。

8.5 Scheduled functions

供SchM模块调用的函数定义:

8.6 Expected Interfaces

依赖其他模块的API接口。

9 Sequence diagrams

本模块涉及流程的顺序图(UML图):

如Can Interface中的例子:

10 Configuration specification

本模块的配置数据及其数据结构的说明。

使用两种说明方法:

a. UML类图:说明配置相关数据结构的组成及引用关系;

b. 表格说明

逐个描述数据结构及数据结构成员。

b.1 数据结构

即Can_ConfigType包含CanGeneral和CanConfigSet。

b.2 数据结构成员

Boolean成员CanDevErrorDetect在CanGeneral结构体中,以及其他各种属性说明。

原文地址:https://www.cnblogs.com/wjcdx/p/9047909.html

时间: 2024-07-31 23:01:08

AUTOSAR-软件规范文档阅读的相关文章

AUTOSAR-软件规范文档中的UML

AUTOSAR软件规范文档中存在两种UML图: Sequence diagrams Configuration diagrams(类图) 顺序图 说明: a. CanIf User: 对象名称,即模块名: b. CanIf_Transimt函数调用,即CanIf User调用CanIf的CanIf_Transimt函数: c. 返回箭头CanIf_Transimt为函数调用完成之后返回,CanIf上从调用开始到返回的宽竖线为函数生命周期: d. alt(alternative): 选择流程,函数

重磅!我组软件测试计划文档发布!

本文档由蹭一蹭软工项目小组撰写,任何复制.使用本文的全部或部分内容的行为必须先征得小组同意,谢谢. 文档:软件测试计划文档 引言 1.1编写目的 编写本测试计划的目的是: (1)     为整个测试阶段的管理工作和技术工作提供指南同时确定测试的内容和范围,为评价系统提供依据: (2)     此外还帮助安排测试活动,说明对资源的需求: (3)     说明测试结果的评价指标. 本文档的主要内容包括: (1)     测试系统简介 (2)     测试方法 (3)     测试标准 (4)    

软件测试计划文档(改)

软件测试计划文档 项目名称:英雄达拉崩吧 小组名称:Scientific_ZEAL软工小分队 项目负责人:刘帅 小组成员:房渤萱 张赐 宋从智 冯惠妍 1.    引言 1.1编写目的 为了尽可能的找出软件的不足,提高软件的质量,促进软件的成功验收,给用户尽可能好的体验.编写本文档.其主要目的在于为所要进行的测试工作制定各种必要的准则和规范,以及在有关方面协议的基础上对测试工作进行合理组织与管理. 1.2项目背景 项目名称:英雄达拉崩吧 项目提出者:Scientific_ZEAL软工小分队 开发

Git帮助文档阅读笔记----第二章-第五节---打标签

本节我们一起来学习如何列出所有可用的标签,如何新建标签,以及各种不同类型标签之间的差别. 列显已有的标签 直接运行 git tag 即可: 可以用特定的搜索模式列出符合条件的标签.在 Git 自身项目仓库中,有着超过 240 个标签,如果你只对 1.4.2 系列的版本感兴趣,可以运行下面的命令: $ git tag -l 'v1.4.2.*' v1.4.2.1 v1.4.2.2 v1.4.2.3 v1.4.2.4 新建标签 轻量级的(lightweight) 含附注的(annotated)(建议

软件project文档中的数据库模型设计

背景:软件project文档之<数据库设计说明书>的结构设计部分要明白规划出数据库的概念结构设计.逻辑结构设计.物理结构设计,就是设计数据库的概念模型.逻辑模型.物理模型.那么.何为数据库的概念模型.逻辑模型.物理模型呢? 反思:当初学习<数据库系统原理>的时候理解不太透彻.亡羊补牢,为时未晚! 概念模型 官方解释:概念设计是依据用户的需求设计数据库的概念结构.它以规范的形式,表达了对用户需求所设计事物的理解,本阶段涉及到术语:实体.实体集.属性.实体标识符. 通俗解释:概念模型就

苹果Xcode帮助文档阅读指南

本文转自:tinyfool 由 tinyfool 发布于 2013年08月21日 | 更新于 3周前 jackwen lionlee Claud 等6人欣赏. 1人反对. 一直想写这么一个东西,长期以来我发现很多初学者的问题在于不掌握学习的方法,所以,Xcode那么好的SDK文档摆在那里,对他们也起不到什么太大的作用.从论坛.微博等等地方看到的初学者提出的问题,也暴露出他们不知道很多他们的疑惑其实在文档里面写的非常清楚.而有时候当他们想从文档去找解决方案的时候,也往往找不到.或者有些人意识到了,

转:苹果Xcode帮助文档阅读指南

一直想写这么一个东西,长期以来我发现很多初学者的问题在于不掌握学习的方法,所以,Xcode那么好的SDK文档摆在那里,对他们也起不到什么太大的作用.从论坛.微博等等地方看到的初学者提出的问题,也暴露出他们不知道很多他们的疑惑其实在文档里面写的非常清楚.而有时候当他们想从文档去找解决方案的时候,也往往找不到.或者有些人意识到了,阅读文档是学习的好办法,但是不得要领. 中国的技术社区有一个很没意思的毛病,就是技术深了,看不懂骂不知所云,技术浅了,看得懂骂没有技术含量.不过管那么孙子做啥,对于现在可能

IOS苹果Xcode帮助文档阅读指南

一直想写这么一个东西,长期以来我发现很多初学者的问题在于不掌握学习的方法,所以,Xcode那么好的SDK文档摆在那里,对他们也起不到什么太大的作用.从论坛.微博等等地方看到的初学者提出的问题,也暴露出他们不知道很多他们的疑惑其实在文档里面写的非常清楚.而有时候当他们想从文档去找解决方案的时候,也往往找不到.或者有些人意识到了,阅读文档是学习的好办法,但是不得要领. 中国的技术社区有一个很没意思的毛病,就是技术深了,看不懂骂不知所云,技术浅了,看得懂骂没有技术含量.不过管那么孙子做啥,对于现在可能

前端开发规范文档(html,css,js)

首先吐槽一句,本来想上传word文档的,可是发现博客不能上传word文档,这就很尴尬了. 首先声明该规范不是本人写的,网上搜前端规范发现这个很详细就先复制下来做笔记,当然不可能啥都按规范来,每个公司的规范都不一样..仅供参考 前端开发规范文档 Html规范 1 代码风格 1.1 缩进 **[强制]**使用 4 个空格作为一个缩进层级,不允许使用 2 个空格或 tab 字符: 2 属性 2.1 属性引号 **[强制]**对于属性的定义使用双引号,不允许使用单引号,不允许不使用引号: 示例: <!-