代码文档编写规范
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
* History:
*******************************************************************************/
*******************************************************************************/
附录
.h文件
.c文件
示ቤተ መጻሕፍቲ ባይዱ：
/******************** (C) COPYRIGHT @ ********************
* File Name :
* Author :
* Date First Issued:
* Description:
********************************************************************************
函数库说明
falshWR.c函数库说明：
Read_Flash_Word函数说明：（u32 Read_Flash_Word(u32 Address)）
表3 Read Flash Word函数说明
功能描述
对外置flash进行读写
输入参数
u32 Address，表示地址
输出参数
无
函数返回值
U32 data,一个字的数据
/*******************************************************************************
* Function Name :
* Description:
* Input :
* Output :
* Return :
*******************************************************************************/
全局变量
内部变量
（可选填）
H文件中存放的函数和全局变量、C文件中的所有函数库均需要进行说明。
特殊关键部分代码
特殊、关键部分代码。
测试方案
测试方法。
XXX功能块设计（同上）
代码格式
H文件中存放的函数和全局变量、C文件中的所有函数库均需要进行说明。
每一段代码前需用注释标注该段代码的功能、作者、时间、输入、输出等。代码若有特殊功能如加密、特殊算法等需要用文字注明。
名称
代码文档编写规范
版本
V2.0
共7页
版本记录
版本号
日期
修改人
修改说明
说明该代码用于什么项目，有什么功能。
图目录（>5张图要设目录）
未找到图形项目表。
表目录（>5个表格要设目录）
代码功能实现及原理说明
设计指标
符合XXX协议V.X.X
表1 协议表
总体设计方案
XX功能块设计
功能表
表2 XX功能
流程图
图1 代码流程图
*******************************************************************************/
*******************************************************************************/
附录
.h文件
.c文件
示ቤተ መጻሕፍቲ ባይዱ：
/******************** (C) COPYRIGHT @ ********************
* File Name :
* Author :
* Date First Issued:
* Description:
********************************************************************************
函数库说明
falshWR.c函数库说明：
Read_Flash_Word函数说明：（u32 Read_Flash_Word(u32 Address)）
表3 Read Flash Word函数说明
功能描述
对外置flash进行读写
输入参数
u32 Address，表示地址
输出参数
无
函数返回值
U32 data,一个字的数据
/*******************************************************************************
* Function Name :
* Description:
* Input :
* Output :
* Return :
*******************************************************************************/
全局变量
内部变量
（可选填）
H文件中存放的函数和全局变量、C文件中的所有函数库均需要进行说明。
特殊关键部分代码
特殊、关键部分代码。
测试方案
测试方法。
XXX功能块设计（同上）
代码格式
H文件中存放的函数和全局变量、C文件中的所有函数库均需要进行说明。
每一段代码前需用注释标注该段代码的功能、作者、时间、输入、输出等。代码若有特殊功能如加密、特殊算法等需要用文字注明。
名称
代码文档编写规范
版本
V2.0
共7页
版本记录
版本号
日期
修改人
修改说明
说明该代码用于什么项目，有什么功能。
图目录（>5张图要设目录）
未找到图形项目表。
表目录（>5个表格要设目录）
代码功能实现及原理说明
设计指标
符合XXX协议V.X.X
表1 协议表
总体设计方案
XX功能块设计
功能表
表2 XX功能
流程图
图1 代码流程图