Skip to content

Mao-cpu/Algrithm_platform

Repository files navigation

2022软件工程实验三--项目代码规范说明(python)

项目 规则
缩进 (1)程序块要采用缩进风格编写,缩进的空格数为4个;
(2)缩进或者对齐只能使用空格键,不可使用TAB键,使用TAB键需要设置TAB键的空格数目是4格 ;
变量命名 (1)命名尽量使用英文单词,力求简单清楚;
(2)命名规范必须与所使用的系统风格保持一致,并在同一项目中统一;
(3)全小写或全大写(可加下划线);
每行最多字符数 (1)较长的语句(>100 字符)要分成多行书写 )要分成多行书写;
函数最大行数 (1)函数的规模尽量限制在100 行以内;
函数、类命名 (1)模块尽量使用小写命名,首字母保持小写,尽量不要用下划线;
(2)类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头;
(3)函数名一律小写,如有多个单词,用下划线隔开;
常量 (1)常量使用以下划线分隔的大写命名;
空行规则 (1)模块级函数和类定义之间空两行;
(2)类成员函数之间空一行;
空格规则 (1)关键字之后要留空格。 const、virtual、inline、case 等关键字之后至少要留一个空格;
(2)if、for、while 等关键字之后应留一个空格再跟左括号‘( ’, 以突出关键字;
(3)变量名后紧跟逗号,逗号后空格;
注释规则 (1)“#”号后空一格,段落间用空行分开(同样需要“#”号);
(2)不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等;
操作符前后空格 (1)在二元运算符两边各空一格 =, -, +=, ==, >, <, >=, <= 等等。