浅说代码风格 - 数据结构课程设计

数据结构课程设计代码风格（待商榷）

一变量的命名规则

1变量的命名需要能够表达其实际的含义，以英文单词或者是英文单词的组合命名。循环计数变量可以使用i，j等命名。绝对禁止使用拼音来命名变量。

2待定使用哪种命名风格规则。

常见的命名的风格一种是“驼峰式风格”（多见于windows编程），标示符有一个或是多个的单词组成，除第一个单词的首字母使用小写，其后的单词的首字母使用大写字母开头。例如“studentName”、“tempFileName”等。另一种的命名风格是使用下划线来分隔英文单词（多见于linux编程）。并且所有的单词都是用小写字母来书写。

3操作系统或者是c标准库中的函数在命名时使用的是一个或者是两个下划线来命名，所以在命名变量时避免使用下划线。

4常量全部使用大写字母来命名，其中包括使用define和const。

5自定义的数据类型全部使用大写字母来命名。“typedef struct student {...} STUDENT

6变量注释。使用//还是使用/**/待商榷 

二代码缩进与空格      注意使用代码的缩进来增加代码的清晰度

1c语言空格使用说明

1)一元运算符（包括“++”、“——”、“*（间接运算符）”、“&（取地址运算符）”、“！（逻辑非）”、一元位运算符等）与其操作数之间不需要打空格；

         2)二元运算符（包括“+”、“-”、“*”、“/”、“%”、“=”、“<”、“<=”、“>”、“>=”、“==”、“+=”、“-=”、“*=”、“/=”、“%=”、“&&（逻辑且）”、“||（逻辑或）”；

         3)三元运算符“？：”和其操作数之间也要有空格间隔。

4)用于通过指针访问结构体成员的运算符“->”和通过变量访问结构体成员的点，运算符“.”与其操作对象之间不需要空格；

5)特殊的运算符sizeof与其操作对象之间要有空格，因为sizeof是一个C语言关键字（参阅本部分第5条）；此外，sizeof作用于一种数据类型时，该数据类型必须用括号括起来（如：sizeof (int)）；作用于一个变量时，变量可以不加括号，但是推荐依然是用括号将其括起来。

6)（待商榷）函数参数列表中参数之间要以逗号和空格间隔开。

 

7）（待商榷）C语言关键字与其后面的代码之间要有一个空格间隔，容易遗忘的地方是for循环、while循环、do…while循环、if判断、if / else if分支跳转、switch分支跳转、sizeof运算符等语句中的空格间隔。

 

8）（待商榷）每一个括号与其所括住的内容之间都要加空格。

9）对于某些if条件语句较长的话，如果需要在多行书写，尽量将同一个条件书写在同一行，“与或非“条件说明符的位置待定（在行尾或者是行的开始）

 

9）待补充

2空行的使用

         1）

三控制结构 while for if switch

1控制结构中语句即时只有一条语句，也使用{}来括起来。

 

2待商榷控制结构中的空格

3一个代码“语句块”结束，要尽量明确注释出结束标志“end function()……”等，对于比较长的循环（for、while、do...while）的循环体或分支结构（if、if...else、switch）语句块，也尽量做这样的结束标志性注释

 

4代码块中的{}位置待定

 

四函数

1函数注释

C语言中注释的风格有两种（见变量注释），函数的原型声明处注释应包括，说明函数的功能，描述函数的参数列表以及返回值。具体格式待商榷，示例：

 

 

2函数中使用变量要尽量在函数的开始出声明，并且需要使用变量注释来解释变量含义(除非变量是temp，i，j等)。注释格式见变量注释格式待商榷。

3两个函数之间需要使用空行来分隔，以使函数代码体清晰。

4待补充

五文件

1头文件和源文件

头文件说明信息（文件名称，主要内容简介，作者，完成时间，修改时间及修改容）具体格式待商榷。

 

 

未完待补充