C/C++源代码书写规范

C/C++源代码书写规范

1. 在.cpp的开头应有一段格式统一的说明,内容包括:

a. 文件名 (FileName);

b. 简短说明文件功能、用途 (Comment);

c. 创建人 (Creater);

d. 文件创建时间 (Date)。

例:

//////////////////////////////////////////
//
// FileName: ***.cpp
// Creator: piaocoder
// Date: ****-**-**
// Comment: ***
//
//////////////////////////////////////////

2. 对于主要功能函数应有注释说明。内容包括:功能、入口/出口参数,必要时还可有备注或补充说明,对于函数中的主要功能代码,也应有注释说明。注释以英文为主。

3. 每行代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。

例:

HANDLE CSOpenFile(const char cszFileName[],                  int nMode);

或者:

BOOL CSReadFile(HANDLE hFile,                void *pvBuffer,                int nReadSize,                int *pnReadSize                );

4. 循环、分支代码,判断条件与执行代码不得在同一行上。

例:正确:

if (n == -2)
    n = 1;
else
    n = 2;

不得写做:

if (n == -2) n = 1;
else n = 2;

5. 指针的定义,* 号既可以紧接类型,也可以在变量名之前。

例:可写做:int* pnsize;

也可写做:int *pnsize;

但不得写做:int * pnsize;

6. 在类的成员函数内调用非成员函数时,在非成员函数名前必须加上“::”。

7. 函数入口参数有缺省值时,应注释说明。

例:

BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace /* = TRUE */);

或者:

BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace );// = TRUE

8. else if 必须写在一行。

9. 与‘{’、‘}’有关的各项规定:

9.1 ‘{’、‘}’应独占一行。在该行内可有注释。

例:正确:

for (i = 0; i < cbLine; i++)
{ // .....
    printf("Line %d:", i);
    printf("%s\n", pFileLines);
}

不得写做:

for (i = 0; i < cb; i++)
{printf("Line %d:", i);
printf("%s\n", pFileLines);}

9.2 ‘{’必须另起一行,‘{’之后的代码必须缩进一个Tab。‘{’与‘}’必须在同一列上。

例:正确:

if (i > 0)
{
    m = 1;
    n++;
}

不得写做:

if (i > 0){
        m = 1;
        n++;
}

例外:

if (i == 0)
{ ASSERT(FALSE); return; }

9.3 在循环、分支之后若只有一行代码,虽然可省略‘{’、‘}’,但不推荐这么做。若省略后可能引起歧义,则必须加上‘{’、‘}’。

例:正确:

if (n == -2)
    n = 1;
else
    n = 2;

或者:

if (n == -2)
    { n = 1; }
else if (n != nTemp)
    { n = 2; }
else
    { n = 3; }

不得写做:

if (n == -2)
    n = 1;
else if (n != nTemp)
    n = 2;
else
    n = 3;

不推荐:

if (i < 1)
    { n = 1; }
else
{
    if (i == 1)
        { n = 2; }
    else
    {
        if (i > 1)
            { n = 3; }
    }
}

10. 与空格有关的各项规定。

10.1 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘->’、‘::’、‘.’、‘[’、‘]’等运算符前后,及‘&’(取地址)、‘*’(取值)等运算符之后不得有空格。

例:正确:

int n = 0, nTemp;

for (int i = nMinLine; i <= nMaxLine; i++)

(condition) ? funct1() : func2();
Or
    (condition)
      ? long statement
      : another long statement;

不得写做:

int n=0, nTemp;

for ( int i=nMinLine; i<=nMaxLine; i++ )

10.2 for、while、if 等关键词之后应有1个空格,再接‘(’,之后无空格;在结尾的‘)’前不得有空格。

例:正确:

if (-2 == n)

不得写做:

if(-2 == n)

if ( -2 == n )

10.3 调用函数、宏时,‘(’、‘)’前后不得有空格。

例:正确:

printf("%d\n", nIndex);

不得写做:

printf ("%d\n", nIndex);
printf( "%d\n", nIndex );

10.4 类型强制转换时,‘(’‘)’前后不得有空格

例:可写做:

(KSFile*)pFile;

也可写做:

(KSFile *)pFile

不得写做:

( KSFile* )pFile
( KSFile * ) pFile

10.5 代码行内的空格规则:

(1)关键字之后需要加空格

(2)函数名之后不能留空格

(3)‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

(4)‘,’之后要留空格,如果‘;’不是一行的结束符,其后应该留空格。

(5)一般的二元操作符前后都应该留空格。

(6)一般一元操作符前后都不加空格。

(7)像“[]”、“.”、“->”这类操作符前后不加空格。

11. 与缩进有关的各项规定

11.1 缩进以 Tab 为单位。1 个 Tab 为 4 个空格

11.2 下列情况,代码缩进一个 Tab:

1. 函数体相对函数名及‘{’、‘}’。

例:

int Power(int x)
{
  return (x * x);
}

2. if、else、for、while、do 等之后的代码。

3. 一行之内写不下,折行之后的代码,应在合理的位置进行折行。若有 + - * / 等运算符,则运算符应在上一行末尾,而不应在下一行的行首。

11.3 下列情况,不必缩进:switch 之后的 case、default。

例:

switch (nID)
{
    case ID_PLAY:
  ......
  break;
    case ID_STOP:
  ......
  break;
    default:
  ......
  break;
}
时间: 2024-10-05 12:46:14

C/C++源代码书写规范的相关文章

代码书写规范和命名规范

上一篇给大家分享了一下,关于文档编写的几个概念.这篇文章阐述如果编写代码书写规范以及命名规范文档.[以java语言为例] 1.代码书写规范 代码书写规范,能够让不同的人,写出相同风格的代码.很多人都看过java源代码,你会发现java源代码的整体风格几乎是一致的,但是你要知道编写源代码的人是很多的,如何才能让他们写出同一风格的代码呢?这就是代码书写规范的作用. 代码书写规范描述的是如何从头到尾书写代码(自己定义的).通俗点讲就是如何书写java文件.就像你写毕业论文一样,从头到尾每个细节都是有要

CSS 书写规范与reset

今天打开学校的官网看了看网页的源代码,虽然之前自己学过HTML CSS JS之类,但是却没有项目.有时候有问题也看过一些blog,发现blog上讲解确实详细很多.今天主要了解了CSS的书写规范跟重置,下面是学校网站上的CSS文件. @charset "utf-8"; /* ----------------------------------------------------------------------- * BYR Common CSS * Copyright (c) 201

CSS 样式书写规范

CSS书写顺序 1.位置属性(position, top, right, z-index, display, float等)2.大小(width, height, padding, margin)3.文字系列(font, line-height, letter-spacing, color- text-align等)4.背景(background, border等)5.其他(animation, transitio CSS书写规范 使用CSS缩写属性 CSS有些属性是可以缩写的,比如paddin

css书写规范

  一.CSS书写顺序     1.位置属性(position, top, right, z-index, display, float等)    2.大小(width, height, padding, margin)    3.文字系列(font, line-height, letter-spacing, color- text-align等)    4.背景(background, border等)    5.其他(animation, transition等) 二.CSS书写规范    

CSS书写规范、顺序和命名规则

一.CSS书写顺序 1.位置属性(position, top, right, z-index, display, float等)2.大小(width, height, padding, margin)3.文字系列(font, line-height, letter-spacing, color- text-align等)4.背景(background, border等)5.其他(animation, transition等) 二.CSS书写规范 1.使用CSS缩写属性 CSS有些属性是可以缩写的

12_Shell语言———脚本的书写规范以及检查和调试脚本

一.脚本的书写规范 在前文中写过一个脚本first.sh,用来创建一个用户,这里新创建一个脚本useradd.sh,用来创建多个用户,用户名和密码相同: # nano useradd.sh #! /bin/bash # Author: Mickey // 指定作者 # Date:2014-5-14 // 指定日期 # Version:0.0.1 // 指定版本 # Description:Add Users // 描述脚本的功能 # 上述内容为规范的脚本格式 useradd userA echo

css命名规范和书写规范

1.位置属性(position, top, right, z-index, display, float等)2.大小(width, height, padding, margin)3.文字系列(font, line-height, letter-spacing, color- text-align等)4.背景(background, border等)5.其他(animation, transition等) CSS书写规范 使用CSS缩写属性 CSS有些属性是可以缩写的,比如padding,mar

&lt;转&gt;CSS书写规范、顺序(推荐)

CSS书写顺序 1.位置属性(position, top, right, z-index, display, float等) 2.大小(width, height, padding, margin) 3.文字系列(font, line-height, letter-spacing, color- text-align等) 4.背景(background, border等) 5.其他(animation, transition等) CSS书写规范 使用CSS缩写属性 CSS有些属性是可以缩写的,比

推荐大家使用的CSS书写规范、顺序(转)

写了这么久的CSS,但大部分前端er都没有按照良好的CSS书写规范来写CSS代码,这样会影响代码的阅读体验,这里设计达人网总结一个CSS书写规范.CSS书写顺序供大家参考,这些是参考了国外一些文章以及我的个人经验总结出来,我想对写CSS的前端用户来说是值得学习的. CSS书写顺序 1.位置属性(position, top, right, z-index, display, float等) 2.大小(width, height, padding, margin) 3.文字系列(font, line