结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点;

我的工程实践是《服务器风扇转速智能控制》主要任务是开发一个应用,根据服务器内的版卡的功耗和温度,智能的调控服务器的风扇转速。主要涉及风扇转速智能控制算法设计,linux系统下的应用开发,服务器风扇控制编成,板卡温度读取编成技术。
编程语言是c语言或者汇编语言。
这次我选择的源代码是基于pid算法的温度控制系统。因为是编写的是底层的函数库,要求程序速度快,空间小,因此代码较为简短,目录结构比较简单,只有两个文件。文件名比较简单。
由于没有使用面向对象语言,所以不存在类名。函数名和变量名都是符合c语言变量与函数命名规范。普通变量使用小写英文单词,较长单词使用缩写,多个单词用下划线相连。常量使用大写。函数名英文单词首字母大写。变量名和函数名直观可以拼读,从名字可以大致知晓变量与函数作用。
接口定义要求简洁明了,能用传地址就不传值。尽量数据耦合减少控制耦合。
单元测试组织形式,由于本程序是由一个函数调用其他函数组织而成,单元测试从最小的每个函数开始测试,从底向上进行测试。

列举哪些做法符合代码规范和风格一般要求;

程序中有清晰的注释

程序头部有程序整体的说明

每个函数都有注释和说明函数的功能

代码中有适当的注释说明代码段的功能

标识符命名要尽量能直观的反映该标识符的功能

标识符都用英文不用汉语拼音

 

 

列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则,及如何进一步优化改进;

在该源码中缩进并不是很规范

有一部分变量没有注释说明其功能

改进:

缩进的宽度为四个字符,使用tab或者四个空格 两者之一

凡函数 if while for do-while switch 都要使用缩进

 

总结同类编程语言或项目在代码规范和风格的一般要求。

c类语言或者项目在代码规范和风格中一般对于以下七个方面有要求:

1) 空行

定义变量或者函数后就要空行,两个相对独立的程序块、变量说明之后必须要加空行。比如前几行代码完成的是一个功能,后几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰。

2) 空格

关键字之后要刘空格,函数名之后不留空格,分号逗号等之后留空格,双目运算符左右加空格,if for while 等语句可以适当加空格。

3) 成对书写

成对的符号一定要成对书写,如 ()、{}。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。

4) 缩进

缩进可以使用四个空格或者tab建,缩进可以使程序更有层次感。原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进。

5) 对齐

不同模块的代码需要对齐,在同一个花括号内的代码需要缩进。

 

6) 代码行

一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释。

if、else、for、while、do 等语句自占一行,执行语句不得紧跟其后。此外,非常重要的一点是,不论执行语句有多少行,就算只有一行也要加{},并且遵循对齐的原则,这样可以防止书写失误。

7) 注释

C语言中一行注释一般采用//…,多行注释必须采用/*…*/。注释通常用于重要的代码行或段落提示。在一般情况下,源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码,但注意不可过多地使用注释。

 

以下是源代码

 

版权声明:本文为SA19225239原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://www.cnblogs.com/SA19225239/p/11657306.html