软件编码规范。.doc

文档介绍：武汉南瑞测控技术事业部
密级:公司级
编码规范
(采用GB/T19001-2000 ISO9001:2000 标准)
文件编号:CK-RJ-01
版本:
编制:代洁
审核:
批准:
颁布日期:2010-07-29
受控状态:■受控□非受控
变更记录
序号
版本
变更处·变更内容
变更人
/日期
审核人
/日期
批准人
/日期
1

初版
1目的
使程序员遵循共同的编程标准,增强程序的可读性、可维护性。
2适用范围
适用于[软件开发部]
3主要内容
附录1 C++编码规范
附录2 Visual C#编码规范

附录1 C++编码规范
第一章文件结构
版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头,主要内容有:
(1)版权信息。
(2)文件名称,标识符,摘要。
(3)当前版本号,作者/修改者,完成日期。
(4)版本历史信息。
示例1-1 C++/C 头文件的结构
//***********************************************************
// 版权声明:
// XX公司版权所有
// Copyright (C) XX Corporation. All Rights Reserved
// 编号:……
// 编写人:(编写人姓名)
// 日期:yyyy/mm/dd(提交的日期)
// 上版编号:……
// 程序文档名:……
// 备注:
// Revision yyyy/mm/dd (修改人姓名)
// …………
// ……
// Revision yyyy/mm/dd (修改人姓名)
//***********************************************************
头文件的结构
头文件由三部分内容组成:
(1)头文件开头处的版权和版本声明。
(2)预处理块。
(3)函数和类结构声明等。
,头文件的结构参见示例1-2。
【规则1-2-1】为了防止头文件被重复引用,应当用#ifndef/#define/#endif 结构产生预处理块。
【规则1-2-2】用#include <filename> 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。
【规则1-2-3】用#include “”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。为了提高编译速度,如果引用的头文件不在工作目录下,用相对路径指明其所在目录。
【规则1-2-4】不要引用不需要的头文件。
不要在声明文件(*.h)中为了实现文件(*.cpp)包含头文件;已经无用的头文件必须从引用文件列表中去掉;如果是为了调试引入的头文件,用#ifdef _DEBUG /#endif和其他引用文件隔开。
【建议1-2-2】不提倡使用全局变量,尽量不要在头文件中出现象extern int value; 这
类声明。
示例1-2 C++/C 头文件的结构
/***********************************************************
// 版权声明:
// XX公司版权所有
// Copyright (C) XX Corporation. All Rights Reserved
// 编号:……
// 编写人:(编写人姓名)
// 日期:yyyy/mm/dd(提交的日期)
// 上版编号:……
// 程序文档名:……
// 备注:
// Revision yyyy/mm/dd (修改人姓名)
// …………
// ……
// Revision yyyy/mm/dd (修改人姓名)
//***********************************************************/
#ifndef GRAPHICS_H // 被重复引用
#define GRAPHICS_H
#include <> // 引用标准库的头文件
…
#include ".\\BaseClass\\"
#include ".\\BaseClass\\"
…
#ifdef _DEBUG
#include <>
…
#include ".\\Common\\"
…
#endif //_DEBUG