软件编码规范 ppt

软件编码规范C++版 Ver1.1（草稿） 项目: 时间: 编号:

天正软件编码规范

一、 命名规范

1、 通则

1.1、 在所有命名中，都应使用标准的英文单词或缩写，避免使用汉语拼音。 1.2、 所有命名都应遵循达意原则，即名称应含义清晰、明确。 1.3、 所有命名都不易过长，在可表达清晰的前提下越简洁越好。 1.4、 所有命名都应尽量使用全称。

1.5、 在类型名称特别复杂的时候，应使用typedef来定义别名。

2、 标识符

2.1、 标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基

本可以理解的缩写，避免使人产生误解。（较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写）

如下单词的常用缩写

application app argument arg average avg block

华为软件编程规范和范例

〔一〕=====[排版] ]=======. 〔二〕======[注释]=======. 〔三〕=====[标识符命名]=======. 〔四〕=====[可读性]======. 〔五〕=====[变量、结构]=====. 〔六〕=====[函数、过程]=====. 〔七〕=====[可测性]=====. 〔八〕=====[程序效率]=====. 〔九〕=====[质量保证]=====.

〔十〕=====[代码编辑、编译、审查]=====. 〔十一〕=====[代码测试、维护]=====. 〔十二〕=====[宏]=====.

〔一〕 ========[ 排版 ]==========

11-1：程序块要采用缩进风格编写，缩进的空格数为4个 说明：对于由开发工具自动生成的代码可以有不一致。 11-2：相对独立的程序块之间、变量说明之后必须加空行 示例：如下例子不符合规范。 Int ni;

if (!valid_ni(ni)) {

... // program code }

repssn_ind = ssn_data[index].repssn_index; repssn_ni = ss

系统开发规范

系统开发规范

编 制： 莫 小 明

版 本 历 史

1 http://www.China-soa.com 重庆斯欧信息技术有限公司

系统开发规范

目录

1

概述 ................................................................................................................................................................................... 3 1.1. 内容 ....................................................................................................................

C++语言编码规范

一、尽量严格按照要求书写代码，统一书写格式。详细格式参照《参考1_程序格式》。

二、所有头文件都应该使用#define保护来防止头文件被多重包含。

通用的方法：

#ifndef _IPROPETRY_H #define _IPROPETRY_H …… #endif

VC中可以使用的方法： #pragma once

三、使用前置声明等方法，尽量减少头文件依赖；

#pragma once class CUser;

class CTest { public: };

CTest(void); ~CTest(void); CUser* m_pUser;

四、包含的文件应按照项目源代码目录树结构排列，避免使用.（当前目录）和..（父目录）。

例如：

D:\\Work\\project\\src\\base\\logging.h 应该像返样被包含： #include \

五、包含头文件的顺序如下：

CPP的头文件 C系统文件 C++系统文件 其他库头文件 本项目内头文件

六、编写短小的函数，超过200行的函数可以考虑将它拆分；

七、不要使用magic number；把常数定义成常量或者宏来使用；

例子一：

const

C++语言编码规范

一、尽量严格按照要求书写代码，统一书写格式。详细格式参照《参考1_程序格式》。

二、所有头文件都应该使用#define保护来防止头文件被多重包含。

通用的方法：

#ifndef _IPROPETRY_H #define _IPROPETRY_H …… #endif

VC中可以使用的方法： #pragma once

三、使用前置声明等方法，尽量减少头文件依赖；

#pragma once class CUser;

class CTest { public: };

CTest(void); ~CTest(void); CUser* m_pUser;

四、包含的文件应按照项目源代码目录树结构排列，避免使用.（当前目录）和..（父目录）。

例如：

D:\\Work\\project\\src\\base\\logging.h 应该像返样被包含： #include \

五、包含头文件的顺序如下：

CPP的头文件 C系统文件 C++系统文件 其他库头文件 本项目内头文件

六、编写短小的函数，超过200行的函数可以考虑将它拆分；

七、不要使用magic number；把常数定义成常量或者宏来使用；

例子一：

const

编码规范

代码必须符合Java的编码规范。Java的编码规范包括：

?

命名规范

（1） 所有的标识符都只能用ASCII字母(A~Z或a~z)、

数字(0~9)和下划线“-”。

（2） 一个唯一包名的前缀总是全部小写的字母。例如：java.lang.util。

（3） 类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。例如：Customer、

CreditAccount。

（4） 接口的大小写规则与类名相似。例如：Contactable、Prompter。

（5） 方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后

单词的首字母大写。例如：setFirstName(String firstName)、assignrole(SysUseruser)。

（6） 变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短可以顾名思义，易于

记忆。例如：firstName, userAddress。避免单个字符的变量名，除非是一次性的临时变量。

（7） 常量的声明应该全部大写，每个单词之间用“-”连接。例如：MIN_BALANCE、

USER_STATUS_NORMAL。

?

注释规范

（1） 注释尽可能使用“//”

58610140.doc

请在这里输入公司名称 文 档 编 号 XK-DN-2000-10-11-05 产品名称：

产品版本 V 1.0 密级 内部 共 页 软件界面设计及编码标准规范

文 档 作 者： 开发/测试经理：产 品 经 理： 管 理 办：

(仅供内部使用)

____________________ ____________________ ____________________ ____________________

请在这里输入公司名称

版权所有 不得复制

___/___/___ ___/___/___ ___/___/___ ___/___/___

第 1 页 共 9页

日期： 日期： 日期： 日期：58610140.doc

电能质量数据分析软件界面设计及编码标

准规范

版本号 日期 1．0 2000/10/15 文档修改记录 所修改页 8 注 记 常见快捷键规定

Android编码规范

介绍 1.

编码规范对于程序员而言尤为重要，有以下几个原因： ? ? ? ? ? ?

一个软件的生命周期中，80%的花费在于维护

几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

10个工程师写的代码会看起来一个人写的代码。

维护阶段一目了然清晰，可以节省不少时间去熟悉看懂代码等等。

为什么需要编码规范?

命名 2.

包命名

命名规则：一个唯一包名的前缀总是全部小写的ASCII 字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门 (department) ，项目(project)，机器(machine)，或注册名(login names)。

例如： com.hymobile.nloc.activities

规约：包命名必须以com.hymobile开始，后面跟有项目名称（或者缩写）,再后面为模块名

拟 制：内容范畴：保密级别：范围：安全中心 信息安全 保密

全体员工

编码安全规范

V1.0

关键字：

安全, 编码规范 文档类别： 开发技术文档 文件名： 编码安全规范.doc 版本

：

1.0

文档历史

日期 2007-02-19 2007-2-28 2007-3-8 2007-3-12 作者 wolfliu applelin Tony, Coolcyang applelin stevezheng Dum applelin 版本号 V0.1 V0.2 V0.3 V0.4 V0.5 V0.6 备注 分割了一下原来的V0.2的文档，抽出一个单列的格式，以便后续修改。 根据新的格式整理并补充 补充示例

第一篇 防止堆栈溢出类漏洞 ..................................................................................................4 1.1对任何用户输入数据必须首先校验其长度，避免由于长度越界引起的缓冲区溢出。 ..........4 1.2C＋＋和MFC程序字符串处理，选择现有的处理类库，禁止自己编写类库。.......

开发命名规范

JAVA编码规范

目 录

1

概述 ................................................................................................................................... 3 1.1 1.2 1.3 2

编写目的 ............................................................................................................ 3 预期读者 ............................................................................................................ 3 适用范围 ............................................................................................................ 3