From fa5e5d73b5aeacf329a0a83764082a34f40b765c Mon Sep 17 00:00:00 2001 From: Ioding <76096856+Ioding@users.noreply.github.com> Date: Thu, 25 Nov 2021 13:21:36 +0800 Subject: [PATCH 1/8] Add files via upload --- ...40\201\350\247\204\350\214\203_ver0.1.txt" | 146 ++++++++++++++++++ 1 file changed, 146 insertions(+) create mode 100644 "\344\273\243\347\240\201\350\247\204\350\214\203_ver0.1.txt" diff --git "a/\344\273\243\347\240\201\350\247\204\350\214\203_ver0.1.txt" "b/\344\273\243\347\240\201\350\247\204\350\214\203_ver0.1.txt" new file mode 100644 index 0000000..934d691 --- /dev/null +++ "b/\344\273\243\347\240\201\350\247\204\350\214\203_ver0.1.txt" @@ -0,0 +1,146 @@ +/************************************************************************** + NekoTeam程序代码规范 +编写时间:2021-11-23 +版本:ver 0.1 +说明:本规范使用C++语言作为基准编写并参考了腾讯C++编码规范, + 若对应语言无对应特性,请自行处理。 +**************************************************************************/ + + +1 目的 + 为保证本项目具有较统一的编码风格,以保证项目代码的易维护性和编码安全性, +方便成员间交流,并且帮助成员学习普适性的,受广泛开发者所接受的代码规范。 + + +2 适用范围 + 本规范适用于本项目下属所有代码,包括但不限于python,kotlin,java等。 +注:本文仅为基本的代码规范,并不涉及对某种具体程序写法的约束 + + +3 程序版式 +3. 1 规则:程序块需采用缩进风格编写,缩进大小为四个空格。 + 说明: + 若开发工具具备自动缩进功能,请将其配置缩进为四个空格。 + +3. 2 规则:缩进或者对齐只能使用空格键,不可使用制表键 (TAB键)。 + 说明: + 空格键指ASCII码 '\0',TAB键指ASCII码'\t',若将开发工具的TAB键设置为 + 替换成四个空格,则可以使用TAB键。 +注:若混淆空格键和TAB键,在某些情形将产生意想不到的bug,如网页显示时。 + +3. 3 规则:相对独立的程序块之间、变量说明之后必须加空行。 + 说明: + 如以下情形使用空行分开: + 1) 函数之间应该用空行分开; + 2) 逻辑片段之间应该用空行分开; + 3) 每个类声明直接应该用空行分开。 + +3. 4 规则:较长的语句应分成多行书写(约大于80字符)。 + 说明: + 分隔的规律如下: + 1)长表达式在低优先级操作符处划分新行,操作符置于新行之首,划分出的新行 + 应进行适当的缩进,通常相较上一行起始多一个TAP键(设置为四个空格)。 + 2)若函数或过程(如if, for, while)中的参数过长,需进行适当的划分。 + +3. 5 规则:不允许将多个语句写在一行中,一行中只有不多于一个逻辑行。 + 说明: + 一行代码只做一件事,但可将一个语句适当缩进为多行具有逻辑的结构,以便阅读。 + +3. 6 规则:if, for, while 等逻辑控制语句独自占一行,且后续必须加范围限定的中括号 { }。 + 说明: + 若无范围限定的中括号,应自行缩进以展现结构,建议每个中括号各独自占一行, + 前后无其他语句。 + +3. 7 规则:代码行之内应当留有适当的空格。 + 说明: + 采用这种方式的目的是使代码更加清晰,便于他人阅读和修改。 + 具体如下: + 1) 关键字之后要留空格。尤其是if、for、while等关键字应留有一个空格后再接 + 左括号 '(',以突出关键字。 + 2) 函数名后不留空格,紧跟左括号 ')' 以与关键字取别。 + 3) 逗号 ','之后要留空格,如果分号 ';'不是一行的结束符号,也要留空格,如 + for (int i = 0; i < 10; ++i)。 + 4) 算术操作符,比较操作符,逻辑操作符,如加号 '+',等号 '=',等二元操作符 + 前后应当加空格。 + 5) 一元操作符如 非 '!',自加 '++',等前后不加空格。 + 6) 如 '[]', '.', '->' 等操作符前后不加空格。 + 7) 上述未提到的操作符可根据经验自行判断缩进,但需保证代码结构清晰。 + + +4 注释 +4. 1 规则:源文件头部应添加注释,至少包含:生成日期,作者,模块目的/功能。 + 说明: + 例如:(c++下的)下面这段注释比较详细,可不按其格式,形成自己的 + 注释风格,但以上所述信息必须包含其中。 +/************************************************************************ + FileName: Test.cpp + Author: Version: Data: + Description: // 模块描述 + Version: // 版本信息 + Function List: // 主要函数及功能 + 1. ---------------- + History: // 历史修改记录 +