这里写目录标题
- 空格
- 头文件位置
- 换行缩进位置
- 符号左右两边各加一个空格
- 括号前面是否需要加空格
- 分号前不加空格
- 缩进
- 各种分级语句
- 大括号
- 对于if、else以及for循环等其他语句
- 大括号左括号的位置
- 二级目录
- 变量名、函数名
- 变量名
- 函数名
- 在类unix系统下编程
- 注释
- 哪些地方需要注释
- 函数内
- 函数外
- 二级目录
- 二级目录
空格
头文件位置
include 与 <stdio.h> 之间要加一个空格,一个,不多也不少
换行缩进位置
换行缩进时,使用四个空格,而不要使用tab键
但是如果是上一行回车下来,编译器自动缩进的话,是不用改掉的,编译器也是四个空格
符号左右两边各加一个空格
在 > < = + - * /
即大于号小于号等于号加减乘除左右两边都要加一个空格,上面int后面的写法是规范的,if后面的写法是不规范的
而分号前面则不用加空格
括号前面是否需要加空格
在函数定义时,括号紧跟着函数名即可,函数调用时也一样(如上图的peintf函数),括号紧跟着函数名
而对于一些逻辑语句,则要在逻辑词之后加一个空格,即括号前加一个空格
总之,只有逻辑语句的括号前面加空格,其他不加
分号前不加空格
分号前不用加空格,紧跟着前面的句子
缩进
各种分级语句
级别越低的语句,就要在上一级别的语句的基础上缩进四个空格
大括号
对于if、else以及for循环等其他语句
对于if、else以及for循环等其他语句,如果其管辖的代码只有一行,那么他的大括号可以省略,但是,不管有几行,都不要省略
大括号左括号的位置
可以写在上面,但是要与前面的括号之间有一个空格
二级目录
变量名、函数名
变量名
尽量使用直译的单词,有一些较短的单词可以使用去掉元音后的单词(元音:a e i o u)
较长的单词可以使用前几个字母的缩写(一般为三个或者四个字母)
函数名
在类unix系统下编程
小驼峰命名法,小驼峰命名对函数名进行命名通常用于java
在类unix系统下编程时,不会使用小驼峰命名法,而是使用上图所示,不同的字母用下划线分隔
注释
哪些地方需要注释
函数内
我们的注释不是越多越好,对于一些简单的语句,无需加注释,因为人人都能看懂,
我们可以在一个代码块上面写上该代码块实现的功能,位置就在该代码块第一行上面另起一行,之后双斜杠+空格
函数外
如果我们要对一个函数进行定义,之后要表明该函数的作用,可以在函数头上进行注释,注释时要用到三行,如上图所示,在第二行的星号后面加空格之后写注释,最后要以句号结束
同时,还要加上参数的注释信息,如下图:
第二行描述完函数的功能之后,
第三行之后,都要在星号后面空格之后,加上@param,表示参数的意思,之后空格,写上参数,之后再空格,写上参数的注释(注意,最后要保证注释的汉字是对齐的)
最后加上返回值的注释
返回值是@return