代码编写.docVIP

软件代码编写规范制定软件代码编写规范的目的是为了提高软件开发效率和软件的可维护性，提高软件质量。其中主要的规范有：程序风格、注释规范、程序健壮性、可移植性、错误处理及软件模块化规范等组成。目前硬件部从事单片机程序的开发统一采用以ICC为主的AVR单片机开发平台。主要采用C语言进行开发，目前正对C/C++的嵌入式软件开发规范有很多中，以下采用其中一种比较通用的代码规范供参考使用，日后可以在此基础上根据公司技术人员本身的特点做适当修改作为公司代码编写规范。1 文件结构每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C++/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C++程序的定义文件通常以“.cpp”为后缀1.1 文件信息声明文件信息声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：版权信息；文件名称，项目代码，摘要，参考文献；当前版本号，作者/修改者，完成日期；版本历史信息；主要函数描述。?////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// Copyright 2006 NanJing Kuyee Technology Co.Ltd. All Right Reserved//// Filename ：filename.h// Project Code ：The project code about this file// Abstract ：Describe the content of this file summarily// Reference ：......//// Version ：1.1// Author ：the name of author(mender)// Accomplished date ： September 2, 2006//// Replaced version : 1.0 // Original Author : the name of original author(mender)// Accomplished date : September 10, 2006//// Main functions ：// Function 1 Return code Function name(Parameter Explain)// Function 2 Return code Function name(Parameter Explain)// ...// Function n Return code Function name(Parameter Explain)////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////示例1-1 文件信息声明【规则1.1-1】 文件信息声明以两行斜杠开始，以两行斜杠结束，每一行都以两个斜杠开始；【规则1.1-2】 文件信息声明包含五个部分，各部分之间以一空行间隔；【规则1.1-3】 在主要函数部分描述了文件所包含的主要函数的声明信息，如果是头文件，这一部分是可以省略的。1.2 头文件的结构头文件由三部分内容组成： 头文件开头处的文件信息声明(参见示例1-1)；预处理块；函数和类结构声明等。假设头文件名称为 filesystem.h，头文件的结构参见示例1-2。【规则1.2-1】 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块；“#ifndef”或者“#define”后以TAB键代替SPACE键做空格；如果头文件名称是由多个单词组成，则各单词间以下划线“_”连接，例如有头文件名称为“filesystem.h”，则定义如下：“#ifndef _FILE_SYSTEM_H_”；【规则1.2-2】 用 #include filename.h 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)；【规则1.2-3】 用 #include “filename.h” 格式来引用