Skip to content

ChenYH-git/software-engineering

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 

Repository files navigation

编码规范

以下为本项目需遵循的编码规范

  • 缩进
    • 每个if ,for ,while ,与括号之间要有一个空格:
    • if,while,for 等的大括号要换行并与 if,for,while 对齐
    • 赋值符号 = ,比较符号 + - * / 等符号两边要有一个空格
    if (a == b)
    {
        a = b * 2;
    }
    for (;;)
    {

    }
  • 变量命名
    • 变量命名用可表达具体意思的单词前后缀组合而成,组合词首字母需大写
    • 变量命名也可用下划线分割单词的组成形式
    int count;
    int CountKeyNum;
    int Count_Key_Num;
  • 每行最多字符数
    • 每行最多 20 个字符(注释不算)
  • 函数最大行数
    • 一个函数最多 60 行,超过则需要再拆分
  • 函数、类命名
    • 函数名字需反映功能并且带有功能解释的注释,格式如下
// add 返回传入的两个 int 参数相加的结果
int add(int a, int b) {

}

// sub 返回传入的两个 int 参数相减的结果
int sub(int a, int b) {

}
  • 常量
    • 常量须在最上方声明,并有注释解释其作用
  • 空行规则
    • 除主函数需预处理、输入部分,处理部分,输出部分等划分,其他函数体内部不特意空行
    • 应保证函数开头和末尾(包括注释部分),与上下空隔开一行
const int c = 0;

int add(int a, int b) {

}

int sub(int a, int b) {

}
  • 注释规则
    • 函数声明注释须在函数上方一行,函数体内的注释可在某一行代码后面或者在上面独占一行
  • 操作符前后空格

  • 其他规则
    • 不允许直接 if 或 while ,for 加一条语句的写法,必须加大括号
    if (a == b)  // 错误
        a = b * 2;

    if (a == b) // 正确
    {
        a = b * 2;
    }

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages