C语言 函数——代码风格

目录

基本的代码规范

程序版式

对齐(Alignment)与缩进(indent)

变量的对齐规则

空行——分隔程序段落的作用

代码行内的空格——增强单行清晰度

代码行

长行拆分

标识符命名规则

标识符命名的共性规则

windows应用程序命名规则

灵活运用的命名规则

简化的windows应用程序命名规则

注释规范

不好的注释

好的注释

在哪些地方写注释?


基本的代码规范

Basic rules and guidelines of Coding Style

*程序版式

*程序注释

*命名规则

追求

*清晰、整洁、美观、一目了然

*容易阅读,容易测试程序版式

程序版式

对齐(Alignment)与缩进(indent)

——保证代码整洁、层次清晰的主要手段

*位于同一层{和}之内的代码在{右边数格处左对齐

*同层次的代码在同层次的缩进层上

  *现在的许多开发环境、编辑软件都支持“自动缩进”

  *VC中有自动整理格式功能(ALT+F8)

*一般用设置为4个空格的Tab键缩进,不用空格缩进

变量的对齐规则

*数据类型+n个TAB+变量名+[n个TAB]+=+[初始化值];

*例

        char name[20];

        char addr[30];

        char sex="F";

        int age=20;

        float score=90;

空行——分隔程序段落的作用

*在每个函数定义结束之后加空行

*在一个函数体内,相邻两组逻辑上密切相关的语句块之间加空行,语句块内不加空行

代码行内的空格——增强单行清晰度

*关键字之后加空格,但函数名之后不加空格

*赋值、算术、关系、逻辑等二元运算符前后各加一空格

*但一元运算符以及[ ]    .    -   >前后不加空格

        sum = sum + term;

*(向后紧跟,) , ; 向前紧跟,紧跟处不留空格,,;后留一个空格

        Function(x, y, z)

        for (initialization; condition; update)

*对表达式较长的for和if语句,为了紧凑可在适当地方去掉一些空格

        for (i=0; i<10; i++)

        if ((a+b>c) && (b+c>a) && (c+a>b))

代码行

一行只写一条语句,便于测试

一行只写一个变量,便于写注释

        int width;        //宽度

        int height;        //高度

        int depth;        //深度

        int width,height,depth;        //宽度高度深度(不建议)

尽可能在定义变量的同时,初始化该变量

        int sum = 0;

if、for、while、do等语句各占一行,便于测试和维护

        if (width < height)

        {

                DoSomething();//执行语句无论有几条都用{和}将其包含在内

        }

长行拆分

代码行不宜过长,应控制在10个单词或70~80个字符以内

        Studies show that up to ten-word text widths are optimal for eye tracking

实在太长时要在适当位置拆分,拆分出的新行要进行适当缩进

        if ((veryLongVarl >= veryLongVar2)

                &&(veryLongVar3 >= veryLongVar4))

        {

                DoSomething();

        }

        double FunctionName(double variablename1,

                                             double variablename2);

        for (very_longer_initialization;

              very_longer_condition;

              very_longer_update)

        {

                DoSomething();

        }

标识符命名规则

按照执行级别分为:

*共性规则——必须执行

*简化规则——建议采用

*可选规则——灵活运用

标识符命名的共性规则

有意义,直观可拼读,见名知意,不必解码

最好采用英文单词或其组合,切忌用汉语拼音,尽量避免出现数字编号

不要出现仅靠大小写区分的相似的标识符

不要出现名字完全相同的局部变量和全局变量

用正确的反义词命名具有互斥意义的变量或相反动作的函数

*int minValue;

*int maxValue;

*int GetValue(...);

*int SetValue(...);

尽量与所采用的操作系统或开发工具的风格保存一致

*在Linux/Unix平台

        习惯用“小写加下划线”

        function_name

        variable_Name

*Windows风格

        大小写混排的单词组合而成

        FunctionName

        variableName

windows应用程序命名规则

Microsoft公司的Hungarian Notation

主要思想

        在变量和函数名前加上前缀,用于表示变量的数据类型

        【限定范围的前缀】+【数据类型前缀】+【有意义的英文单词】

        限定范围的前缀

                静态变量前加前缀s_ , 表示static

                全局变量前加前缀g_,表示global

                默认情况为局部变量

        数据类型前缀

        ch 字符变量前缀

        i    整形变量前缀

        f    实型变量前缀

        p    指针变量前缀

灵活运用的命名规则

限定范围的前缀与数据类型前缀可要可不要

无特殊意义的循环变量可以直接定义成i,j,k等单词变量

        int i, j, k;

        float x, y, z;

     *若采用匈牙利命名规则,则应写成

        int iI,iJ,iK;     //前缀i表示int类型

        float fx,fy,fz; //前缀f表示float类型

简化的windows应用程序命名规则

变量名形式

*小写字母开头,“名词”或者“形容词+名词”

        oldValue,newValue

函数名形式

*大写字母开头,“动词”或者“动词+名词”(动宾词组)

        GetValue(),SetValue()

宏和const常量全用大写字母,并用下划线分隔单词

        #define ARRAY_LEN 10

        const int MAX_LEN=100;

注释规范

写注释给谁看?

*给自己看,使字节的设计思路得以连贯

*给继任者看,使其能接替自己的工作

写注释的最重要的共性在于传承

*要站在继任者的角度写

*简单明了、准确易懂、防止二义性

*让继任者可以轻松阅读、复用、修改自己的代码

*让继任者轻松辨别出哪些使字节写的,哪些是被人写的

不好的注释

好的注释

在哪些地方写注释?

在重要的文件首部

        文件名+功能说明+【作者】+【版本】+【版权声明】+【日期】

在用户自定义函数前,对函数接口进行说明

        函数功能+入口参数+出口参数+返回值(包括出错处理)

在一些重要的语句上方

        对代码的功能、原理进行解释说明

在一些重要的语句行右方

        定义一些非通用的变量,函数调用,较长的、多重嵌套的语句块结束处

*在修改的代码行旁边加注释

*在调试程序中对暂不使用的语句通常可先用注释符括起来,使编译器跳过这些语句

可灵活运用的一些规则

*注释可长可短,但应画龙点睛,重点加载语义转折处

*简单的函数可以用一句话简单说明

        //两数交换

        void Swap(int *x, int *y)

*内部使用的函数可以简单注释,供被人使用的函数必须严格注释,特别是入口参数和出口参数

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/536843.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

SpringBoot启动时banner设置

SpringBoot启动时banner设置 1.操作步骤2.各种banner图像 1.操作步骤 在application.properties文件中设置新的banner对于的文件位置&#xff0c;最好放在resources目录下 spring.banner.locationbanner.txt2.各种banner图像 &#xff08;1&#xff09;经典大佛图 具体txt文…

Docker学习笔记(一):入门篇,Docker概述、基本组成等,对Docker有一个初步的认识

前言 记录时间 [2024-4-5] 在先前的文章中&#xff0c;笔者进行了Windows系统下YOLOv8模型的简单测试&#xff0c;并由此引发思考&#xff1a;是否能尝试将此模型运行在Linux中呢&#xff1f;又或者&#xff0c;运行在Docker中。关于Docker的学习就这么展开了。 本文便是有关D…

车载视频智能创作解决方案,影视级视频制作

当下车载视频已经不仅仅是一种记录行车过程的方式&#xff0c;更是展现企业品牌形象、传递文化内涵的重要媒介。传统的车载视频制作方式往往耗时耗力&#xff0c;效率低下&#xff0c;无法满足企业对于高质量、高效率的需求。针对这一痛点&#xff0c;美摄科技凭借其在视频智能…

算法 分割字符串为实体类

题目 String userData "10000:张三:男:1998-01-01#10001:张三:男:1998-01-01#10002:李四:女:1999-02-02#10003:王五:男:2000-03-03#10004:赵六:女:2001-04-04"; String[] usersArray userData.split("#"); // 使用Stream API将字符串数组转换为SysUser对…

SpringBoot学习之Kibana下载安装和启动(三十二)

一、简介 Kibana是一个开源的分析与可视化平台,设计出来用于和Elasticsearch一起使用的。你可以用kibana搜索、查看存放在Elasticsearch中的数据。Kibana与Elasticsearch的交互方式是各种不同的图表、表格、地图等,直观的展示数据,从而达到高级的数据分析与可视化的目的。 …

新版网络安全等级保护定级指南解读

网络安全等级保护工作的作用对象&#xff0c;主要包括基础信息网络、工业控制系统、云计算平台、物联网、使用移动互联技术的网络和大数据等。 软件开发全套资料获取进主页或者本文末个人名片直接获取。

【应急响应事件】记一次矿机木马事件

事情起因&#xff0c;是因为实验室有一台服务器的占用率从开机启动就是100%&#xff0c;很怀疑就是中了某种矿机木马&#xff0c;拿去挖矿了&#xff0c;然后经过师兄的不懈努力&#xff0c;终于找到了木马文件&#xff0c;给他命名为virus_sample 然后我就拿着样本去逆了 木马…

前端React笔记(尚硅谷)

react 尚硅谷react教程 jsx语法规则 1.定义虚拟dom时不加引号&#xff08;不是字符串&#xff09; 2.标签中混入js表达式时要用{} js表达式与js语句不同。 js语句是if&#xff08;&#xff09;&#xff0c;for&#xff08;&#xff09;&#xff0c;switch&#xff08;&#x…

Python生成图片和音频验证码

captcha是pyhton的一个模块&#xff0c;用来生成图片和音频验证码。 安装 pip install captcha使用 from captcha.audio import AudioCaptcha from captcha.image import ImageCaptcha# 加载声音和字体 audio AudioCaptcha(voicedir/path/to/voices) image ImageCaptcha(…

Linux的环境搭建

目录 第一步&#xff1a;购买腾讯云轻量级云服务器 Step1&#xff1a;打开腾讯云 ​编辑 Step2&#xff1a;登录腾讯云并完成认证 Step3&#xff1a;选择服务器类型 Step4&#xff1a;选择服务器配置 第二部&#xff1a;下载XShell Step1&#xff1a;打开XShell Step2…

亚马逊云科技云从业者考证自习室招生啦!

今天小李哥安利的是亚马逊云科技国内社区User Group(UG)的最新线上活动&#xff0c;云从业者考证自习室(图1)。该活动将由亚马逊云科技社区技术大牛、考证大牛们&#xff0c;帮助大家在一个月内陪伴式学习、保姆级教学、提供免费备考课程&#xff0c;帮助大家在短短一个月内稳稳…

tensorflow.js 如何从 public 路径加载人脸特征点检测模型

系列文章目录 如何在前端项目中使用opencv.js | opencv.js入门如何使用tensorflow.js实现面部特征点检测tensorflow.js 如何从 public 路径加载人脸特征点检测模型tensorflow.js 如何使用opencv.js通过面部特征点估算脸部姿态并绘制示意图tensorflow.js 使用 opencv.js 将人脸…

ArcGIS Pro中的3D建模

在本文中,我讲述了我最近一直在探索的在 ArcGIS Pro 中设计 3D 模型的过程。 我的目标是尽可能避免与其他软件交互(即使是专门用于 3D 建模的软件),并利用 Pro 可以提供的可能性。 这个短暂的旅程分为三个不同的阶段:准备、组装和照明。 我们必须使用一些布局可能性以及一…

想走?可以!先买票--迭代器模式

1.1 乘车买票&#xff0c;不管你是谁&#xff01; 售票员检查谁没有买票&#xff0c;把车厢里的人都遍历一遍。 1.2 迭代器模式 迭代器模式&#xff08;Iterator&#xff09;&#xff0c;提供一种方法顺序访问一个聚合对象中的各个元素&#xff0c;而又不暴露该对象的内部表示…

计算机导论——C语言001

前言 学习一门语言不是要记住所有这些函数&#xff0c;而是要懂得在哪里找到解决问题的答案 学习英语不是要记住所有单词&#xff0c;而是要懂得查字典&#xff08;因为这样就可以理解单词&#xff0c;并会用单词造句子了&#xff09; 以下侧重于了解输出&#xff08;side eff…

Day16_学点儿JavaEE_实践_基于IDEA2023的简易JavaWeb项目、Tomcat输出乱码解决

0 JavaWeb项目目录 └──JavaWeb├──resources│ └──db.properties├──src│ └──com.sdust.web│ ├──servlet│ │ └──StudentServlet│ ├──pojo│ │ └──Student│ └──util│ └──JDBCUtil├──web│ ├──st…

STM32存储左右互搏 SDIO总线读写SD/MicroSD/TF卡

STM32存储左右互搏 SDIO总线读写SD/MicroSD/TF卡 SD/MicroSD/TF卡是基于FLASH的一种常见非易失存储单元&#xff0c;由接口协议电路和FLASH构成。市面上由不同尺寸和不同容量的卡&#xff0c;手机领域用的TF卡实际就是MicroSD卡&#xff0c;尺寸比SD卡小&#xff0c;而电路和协…

Acrobat Pro DC 2023 for mac直装激活版 pdf编辑处理工具

Acrobat Pro DC 2023 for Mac是一款功能强大的PDF编辑器&#xff0c;为用户提供了全面且高效的PDF处理体验。 软件下载&#xff1a;Acrobat Pro DC 2023 for mac直装激活版下载 首先&#xff0c;它支持用户从现有文档创建PDF&#xff0c;或者将其他文件格式如图片、网页等轻松转…

win11wifi总掉线怎么办,win11连接wifi频繁掉线

很多网友纷纷用上了win11系统,但是由于对win11系统的不熟悉,因此常常在使用的过程中遇到很多问题。几天前,有网友反馈,系统自从升级win11以后,电脑连接wifi上网时,总是会掉线。一般出现此问题,可能是网络没有播报或开启了无线网卡节能模式导致的。那么,win11wifi总掉线…

【Linux】开始了解重定向

送给大家一句话&#xff1a; 人真正的名字是&#xff1a;欲望。所以你得知道&#xff0c;消灭恐惧最有效的办法&#xff0c;就是消灭欲望。 – 史铁生 《我与地坛》 开始了解重定向 1 前言2 重定向与缓冲区2.1 文件描述符分配规则2.2 重定向的现象2.3 重定向的理解2.4 缓冲区…