Skip to content

July:咱们来简单讨论下排版格式、编码规范 #81

Closed
@julycoding

Description

@julycoding

大家可以各抒己见,针对排版格式,尤其是编码规范,有什么看法,最后达成共识,和一致的风格。

暂时用的格式:
一、关于空格
所有代码使用4个空格缩进
运算符后使用一个空格
"," 和for循环语句中的";" 后面跟上一个空格
条件、分支保留字,如 if for while else switch 后留出一个空格
"[]", "."和"->" 前后不留空格
用空行把大块代码分成逻辑上的“段落
C 指针中的指针符靠近类型名,如char* p;

二、关于标点
中文表述,使用全角的标点符号,如:()、。,?
数学公式(包括文中混排的公式)和英文代码,使用半角的标点符号,如:(),.?…
关于注释
注释统一用中文
尽量用"//",除非大段大段的注释,否则一般不用"/.../"

三、关于命名
类名为大写字母开头的单词组合
函数名以小写字母开头,后面紧跟的是大写字母开头的单词,比如maxSubArray
常量的命名都是大写字母的单词,之间用下划线隔开,比如MY_CONSTANT
变量尽量使用全名,能够描述所要实现的功能,如 highestTemprature;对于已经公认了的写法才使用缩写,如 tmp mid prev next
变量名能“望文生义”,如v1, v2不如area, height
il < 4384 和 inputLength < MAX_INPUT_LENGTH,后一种写法更好

四、一个函数只专注做一件事

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions