文档介绍：1. 头文件
※ 采用#ifndef、#define、#endif 结构产生预处理块(设文件名称:)
格式: #ifndef __FILENAME_H__
#define __FILENAME_H__
……
……
#endif
※ 采用#include <> 包含标准库的头文件
※ 采用#include “” 包含非标准库的头文件(自定义头文件)
※ 头文件中只存放“声明”,不存放“定义”
※ ,。
※ ,。
2. 函数结构:
函数说明:
每一个函数“声明”之前有一个函数注释,格式如下:
//------------------------------(30-)
//* 函数原型:void function(unsigned int data Lui_width)
//* 功能描述:函数功能的介绍
//* 输入参数:
// 1. Lui_width 物理意义数据范围
//* 输出参数:无
//* 返回值:无
//* 备注:
//------------------------------(30-)
函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。
如:char get_char(void)
函数声明放在头文件里,函数定义(实现)存放在定义文件里。
函数参数:
※ 参数的书写要完整,如果函数没有参数,则用void填充
※ 系统设置为small存储模式,pact或large
※ 不特别必要时不使用可重入性能函数,使用时函数声明中明确声明
※ 中断函数使用声明时明确声明中断使用寄存器组
如:void set_value (unsigned int data Lui_width, unsigned int data Lui_height) large;
float get_value (void) small interrupt5 using0;
※ 如果函数参数为指针,且仅作输入用,则应在类型前加const,以防止该指针在函数体内
被意外修改
※ 避免函数有太多的参数,参数个数尽量控制在5个以内。如果参数太多,在使用时容易将
参数类型或顺序搞错
※ 不省略返回值的类型。如果返回值为空则用void说明
标示符命名规则:
※ 变量命名:“望名知意”,一般采用“小写加下划线” unsigned char data Luc_variable_name
※ 宏常量: 一般采用大写#define CONST_NAME 200
※ const常量: 前缀加C const unsigned char data Cuc_variable_name 200
※ 静态变量: 前缀加S(static) static unsigned int data Sui_variable_name
※ 全局变量: 前缀加G(global) unsigned char data Guc_variable_name
※ 局部变量: 前缀加L(local) unsigned char data Luc_variable_name
※ 结构体变量前缀加stu(struct) struct stuMyStructure
※ 其中:unsiged 以u标志;signed 以s标志;char 以c标志,int 以i 标志;
float 以f标志;long 以l标志;bit 以b标志;结构体以stu标志;
※ 变量声明时不省略有符号、无符号标志,必须明确声明singed或unsigned
※ 变量声明时明确声明变量存储器类型,必须在定义变量数据类型之后定义存储类型存储器类型如下:(以51单片机为例)
存储器类型说明
data 直接寻址片内存储区(128字节),访问速度快,建议用于底层驱动或中断性、实时性程序
bdata 可位寻址片内数据存储区 (16字节), 允许位与字节混合访问, 建议用于串并/ 并串转换驱动程序和位标志提取程序(此段类型声明产生全局位变量,sbit声明必须使用bdata类型)
idata 间接寻址片内数据存储区,可访问片内全部RAM地址空间(256字节),建议用于常用功能性函数
pdata 分页寻址片外数据存储区(256字节)不建议使用
xdata 片外数据存储区(或片内扩展存储区