跳转至

代码开发规范

作为贡献者,你需要按照以下规范来开发代码:

基本规范

  1. 文件编码要求使用 UTF-8 编码。 若您平常使用的编辑器并非 UTF-8 编码(如:GBK/GB2312/Big5 等编码),请注意在保存文件时,将编码格式转换为 UTF-8。否则文件内容可能会存在乱码问题。请务必注意!

  2. 代码尽量不要手动使用制表符进行缩进。 请尽量在代码中使用空格来代替制表符(即键盘上按下的 Tab 键)进行缩进(缩进单位为:4 个空格),以保持代码的一致性和可读性。

  3. 代码行长度不超过 120 个字符。 为了保持代码的可读性,建议每行代码的长度不要超过 120 个字符。 若代码行长度超过 120 个字符,请考虑使用换行(通常使用 \ 作为换行)来保持代码的可读性。

变量名命名规范

  1. 函数名称必须使用小驼峰命名法且必须易于理解其函数功能。即:第一个单词以小写字母开始,后续单词的首字母大写,其余字母小写。示例:get String DatagetStringData。 若函数命名过长,可考虑简化单词, 示例:get Each Array DatagetEachArrData

  2. 针对函数内部,所有变量名和常量名必须使用下划线命名法(即单词与单词之间使用下划线命名),变量名必须全部使用小写字母,常量名必须全部使用大写字母。若表达式过长,可允许使用变量名代替以增强代码可读性,但尽量不要使用过多变量或常量名,以免增加代码的冗余。 允许出现的变量名:i, j, k(允许在循环内部使用)

  3. 对于全局变量,非必要情况,请尽量不要使用!如确有需要,请再文件开头处进行定义并适当添加注释。 示例:static DebugLevel debugLevel; // 全局调试级别变量