编程规范-程序员们都应该这样写代码(转)-程序员宅基地

技术标签: 测试  c/c++  

基本要求

1.1 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。
1.2 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
1.3 尽量使用标准库函数和公共函数。
1.4 不要随意定义全局变量,尽量使用局部变量。
1.5 使用括号以避免二义性。

2.可读性要求
2.1 可读性第一,效率第二。
2.2 保持注释与代码完全一致。
2.3 每个源程序文件,都有文件头说明,说明规格见规范。
2.4 每个函数,都有函数头说明,说明规格见规范。
2.5 主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。
2.7 常量定义(DEFINE)有相应说明。
2.8 处理过程的每个阶段都有相关注释说明。
2.9 在典型算法前都有注释。
2.10 利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为 6个字节。
2.11 循环、分支层次不要超过五层。
2.12 注释可以与语句在同一行,也可以在上行。
2.13 空行和空白字符也是一种特殊注释。
2.14 一目了然的语句不加注释。
2.15 注释的作用范围可以为:定义、引用、条件分支以及一段代码。
2.16 注释行数(不包括程序头和函数头说明部份)应占总行数的 1/5 到 1/3 。


3. 结构化要求

3.1 禁止出现两条等价的支路。
3.2 禁止GOTO语句。
3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
3.4 用 CASE 实现多路分支。
3.5 避免从循环引出多个出口。
3.6 函数只有一个出口。
3.7 不使用条件赋值语句。
3.8 避免不必要的分支。
3.9 不要轻易用条件分支去替换逻辑表达式。

4. 正确性与容错性要求

4.1 程序首先是正确,其次是优美
4.2 无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。
4.3 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。
4.4 所有变量在调用前必须被初始化。
4.5 对所有的用户输入,必须进行合法性检查。
4.6 不要比较浮点数的相等,
如: 10.0 * 0.1 == 1.0 , 不可靠
4.7 程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等。
4.8 单元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。

5. 可重用性要求

5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
5.2 公共控件或类应考虑OO思想,减少外界联系,考虑独立性或封装性。
5.3 公共控件或类应建立使用模板。

附:C++ 编程规范,delphi作相应的参考


.1适用范围

本标准适用于利用Visul C++ ,Borland C++进行软件程序开发的人员.。



.2变量命名

命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意义字符串,如果连续意义字符串仅两个,可都大写.如OK.

具体例程:

BOOL类型 bEnable;

ch * char chText
c * 类对象 cMain(对象实例)
h * Handle(句柄) hWnd
i * int
n * 无符号整型
p * 指针
sz,str * 字符串
w WORD
x,y 坐标

Char或者TCHAR类型 与Windows API有直接联系的用szAppName[10]形式否则用FileName[10]形式,单个字符也可用小写字母表示;

Int类型 nCmdShow;
LONG类型 lParam;
UINT类型 uNotify;
DWORD类型 dwStart;
PSTR类型 pszTip;
LPSTR类型 lpCmdLine
LPTSTR类型 lpszClassName;
LPVOID类型 lpReserved
WPARAM类型 wParam,
LPARAM类型 lParam
HWND类型 hDlg;
HDC类型 hDC;
HINSTANCE类型 hInstance
HANDLE类型 hInstance,
HICON类型 hIcon;
int iTmp
float fTmp
DWORD dw*
String , AnsiString str *
m_ 类成员变量 m_nVal, m_bFlag
g_ 全局变量 g_nMsg, g_bFlag

局部变量中可采用如下几个通用变量:nTemp,nResult,I,J(一般用于循环变量)。

其他资源句柄同上

.3常量命名和宏定义

常量和宏定义必须具有一定的实际意义;
常量和宏定义在#include和函数定义之间;
常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用;
资源名字定义格式:

菜单:IDM_XX或者CM_XX
位图:IDB_XX
对话框:IDD_XX
字符串:IDS_XX
DLGINIT:DIALOG_XX
ICON:IDR_XX

.4函数命名

函数原型说明包括引用外来函数及内部函数,外部引用必须在右侧注明函数来源: 模块名及文件名, 如是内部函数,只要注释其定义文件名;

第一个字母必须使用大写字母,要求用大小写字母组合规范函数命名,必要时可用下划线间隔,示例如下:

void UpdateDB_Tfgd (TRACK_NAME); //Module Name :r01/sdw.c
void PrintTrackData (TRACK_NAME); //Module Name :r04/tern.c
void ImportantPoint (void); //Module Name :r01/sdw.c
void ShowChar (int , int , chtype); //Local Module
void ScrollUp_V (int , int); //Local Module

.5结构体命名

结构体类型命名必须全部用大写字母,原则上前面以下划线开始;结构体变量命名必须用大小写字母组合,第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数据区,必须注明其所属的进程。全局数据定义只需注意其用途。

示例如下:

typedef struct
{
    char szProductName[20];
    char szAuthor[20];
    char szReleaseDate[16];
    char szVersion[10];
    unsigned long MaxTables;
    unsigned long UsedTables;
}DBS_DATABASE;

DBS_DATABASE GdataBase;

6 控件的命名:
用小写前缀表示类别:
fm 窗口
cmd 按钮
cob combo,下拉式列表框
txt 文本输入框
lab labal,标签
img image,图象
pic picture
grd Grid,网格
scr 滚动条
lst 列表框
frm fram

7注释

原则上注释要求使用中文;

文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明;
函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;
程序中注释包括:修改时间和作者、方便理解的注释等;

引用一: 文件开头的注释模板

/******************************************************************
** 文件名:
** Copyright (c) 1998-1999 *********公司技术开发部
** 创建人:
** 日 期:
** 修改人:
** 日 期:
** 描 述:
**
** 版 本:
**-----------------------------------------------------------------------------
******************************************************************/

引用二: 函数开头的注释模板
/*****************************************************************
** 函数名:
** 输 入: a,b,c
** a---
** b---
** c---
** 输 出: x---
** x 为 1, 表示...
** x 为 0, 表示...
** 功能描述:
** 全局变量:
** 调用模块:
** 作 者:
** 日 期:
** 修 改:
** 日 期:
** 版本
****************************************************************/

引用三: 程序中的注释模板
/*----------------------------------------------------------*/
/* 注释内容 */
/*----------------------------------------------------------*/

8 程序

a. 程序编码力求简洁,结构清晰,避免太多的分支结构及太过于技巧性的程序,尽量不采用递归模式。
b. 编写程序时,亦必须想好测试的方法,换句话说,”单元测试” 的测试方案应在程序编写时一并拟好。
c. 注释一定要与程序一致。
d. 版本封存以后的修改一定要将老语句用/* */ 封闭,不能自行删除或修改,并要在文件及函数的修改记录中加以记录。
e. 程序中每个block 的开头 ”{" 及 "}” 必须对齐,嵌套的block 每进一套,缩进一个tab,TAB 为4个空格,block类型包括if、for、while、do等关键字引出的。
f. 对于比较大的函数,每个block 和特殊的函数调用,都必须注明其功能,举例如下:

count.divisor = 1193280 / freq; // compute the proper count
OutByte((unsigned short)67, (unsigned char)182); // tell 8253 that acount is coming
OutByte((unsigned short)66, count. c[0]); // send low-order byte
OutByte((unsigned short)66, count. c[1]); // send high-order byte
×××××××××××××××××××××××××××××××××××××××

bcb,delphi中的变量命名:

遵循匈牙利命名法,命名必须有意义,制定如下规定

窗体: 以大写的W开始,如About版权窗体, 命名为WAbout
文件:以大写的F开始,如About版权窗体,文件命名为FAbout.cpp
按钮(Button):如退出按钮,命名为btnExit
……
基类: 加base标记,如报表基类,窗体命名为:WBaseRep, 文件命名为FBaseRep.cpp

转载于:https://www.cnblogs.com/xh831213/archive/2006/02/07/326660.html

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_30485291/article/details/97408300

智能推荐

22.Spring Cloud Alibaba Seata处理分布式事务_seata insert all-程序员宅基地

文章浏览阅读187次。Spring Cloud Alibaba Seata处理分布式事务基于分布式的事务管理前言这篇博客我是不想发的,因为这里面的事务回滚功能,并没有完美实现,如果你看到这篇博客的话,就当做了解即可,以后有了解决方案的话,我再更新。分布式事务分布式之前,单机单库没有这个问题,从 1:1 -> 1:N -> N:N跨数据库,多数据源的统一调度,就会遇到分布式事务问题如下图,单体应用被拆分成微服务应用,原来的三个模板被拆分成三个独立的应用,分别使用三个独立的数据源,业务操作需要调用三个_seata insert all

php isset()与empty()的使用 完美版_php empty和isset同时使用-程序员宅基地

文章浏览阅读468次。PHP isset函数作用isset函数是检测变量是否设置。格式:bool isset( mixed var [, mixed var [, ...]] )返回值:若变量不存在则返回FALSE若变量存在且其值为NULL,也返回FALSE若变量存在且值不为NULL,则返回TURE同时检查多个变量时,每个单项都符号上一条要求时才返回TRUE,否则_php empty和isset同时使用

GLSL程序对象的C++封装_c++ glsl-程序员宅基地

文章浏览阅读5.4k次,点赞2次,收藏6次。在OpenGL的shader编程中,最常用的可能就是程序对象了,GLSL的程序对象的创建、加载shader等步骤都是固定的,如果每次都写同样的代码,觉得十分浪费时间,所以现在就将我在Shader学习过程中自己封装的GLSLProgram类奉献出来供大家参考:头文件如下:/* * GLSLProgram.h * * Created * Author: zhouxuguang *_c++ glsl

2022史上最全java面试题题库大全800题含答案_面试题库精选800题-程序员宅基地

文章浏览阅读1.1k次。2022史上最全java面试题题库大全800题含答案1、meta标签的作用是什么2、ReenTrantLock可重入锁(和synchronized的区别)总结3、Spring中的自动装配有哪些限制?4、什么是可变参数?5、什么是领域模型(domain model)?贫血模型(anaemic domain model)和充血模型(rich domain model)有什么区别?6、说说http,https协议7、"= ="和equals方法究竟有什么区别?8、&和..._面试题库精选800题

蓝牙技术 A2DP AVRCP BlueZ-程序员宅基地

文章浏览阅读604次。BlueZ 做为 linux 标准的协议栈,提供非常多的 profile ,各种的支持,ble , 蓝牙网络,文件传输,a2dp 音频传输。A2DP——Advanced Audio Distribution Profile A2DP Sink 输入设备,如蓝牙耳机。A2DP Source 输出设备,如手机。音频压缩格式支持:其中SBC是必须支持的,可选的格式有MPEG-1, M..._bluez avrcp

iOS CoreAnimation_ios coreanimation catiledlayer-程序员宅基地

文章浏览阅读544次。核心动画,开发人员可以为他们的应用创建动态用户界面,而无需使用低级别的图形 API,如 OpenGL 来获取高效的动画性能。 前言,核心动画的好处1.简单易用的高性能混合编程模型。2.类似视图一样,你可以通过使用图层来创建复杂的接口。 通过是CALayer来使用更复杂的一些动画。 3.轻量级的数据结构,它可以同时显示并让上百个图层产生动画效果。 控制多个CALayer来显示动画效果 4.一套简单的_ios coreanimation catiledlayer

随便推点

JAVA面试题大全(200+道题目)-程序员宅基地

文章浏览阅读1.8w次,点赞22次,收藏222次。面试题一、Java 基础1.JDK 和 JRE 有什么区别?2.== 和 equals 的区别是什么?3.两个对象的 hashCode()相同,则 equals()也一定为 true,对吗?4.final在 java 中有什么作用?5.java中的 Math.round(-1.5) 等于多少?6.String 属于基础的数据类型吗?7.java中操作字符串都有..._java面试题

微信小程序中的收藏功能(包含用户需求,数据库设计,后台功能,微信小程序功能,效果截图等)_小程序收藏功能-程序员宅基地

文章浏览阅读7.6k次,点赞15次,收藏75次。目录1.用户需求2.数据库设计3.Java后台实现3.1Mybatis对应的配置文件GoodsCollectDao.xml3.2 GoodsCollectDao实现3.3 Service接口及实现4.微信小程序实现4.1index.wxml4.2 index.wxss5.我的收藏效果1.用户需求我的收藏需求如下:1).在小程序的底部菜单中,新增“我的收藏”,显示收藏商品列表。点收藏某个商品后,跳转到商品详情2).商品详情页面,可以收藏和取消收藏。_小程序收藏功能

Java 数字千位分隔符_bigde 千分位分隔符-程序员宅基地

文章浏览阅读6k次。package com.zing;import java.math.BigDecimal;import java.text.DecimalFormat;public class Test {public static void main(String[] arg) {BigDecimal bd = new BigDecimal(123456789.3);System.out.pr_bigde 千分位分隔符

python单链表:头插法、尾插法创建, 判空, 长度, 遍历, 增加3种, 查找2种, 修改2种, 删除2种_数据结构头插法建立单链表python-程序员宅基地

文章浏览阅读2k次,点赞5次,收藏33次。文章目录前言一、单链表是什么?二、写代码时注意点:三、代码1.每一个结点的创建2.Linklist完整代码3.代码测试前言单链表是数据结构中为非常基础的内容,所以我们也来简单学一下喽^-^一、单链表是什么?单链表是存储、操作数据的一种基本结构,类似于只能单向遍历的列表,只是连接时靠结构体依次连接。二、写代码时注意点:1.关联性:将self.head赋值给临时变量时,改变变量由self.head带来的相关属性时,会改变self.head的相关属性_数据结构头插法建立单链表python

objc-internal.h_ios中_internal.h-程序员宅基地

文章浏览阅读482次。文档地址:http://www.opensource.apple.com/source/objc4/objc4-493.9/runtime/objc-internal.h/* * Copyright (c) 2009 Apple Inc. All Rights Reserved. * * @APPLE_LICENSE_HEADER_START@ * * This f_ios中_internal.h

C#写串口上位机程序,read方法不能整行读取解决办法_c#通过调用一次read()方法并不能确保所读取的数据就是完整一帧-程序员宅基地

文章浏览阅读1.7k次。在用C#写串口相关的上位机的时候,遇到了一个问题:用串口read方法有时不能读取完整的一个字符串,总是需要多次触发接收,这样显示出来不太直观。于是改用readline方法,完美解决。_c#通过调用一次read()方法并不能确保所读取的数据就是完整一帧