代码编写规范

这里写目录标题

  • 空格
    • 头文件位置
    • 换行缩进位置
    • 符号左右两边各加一个空格
    • 括号前面是否需要加空格
    • 分号前不加空格
  • 缩进
    • 各种分级语句
  • 大括号
    • 对于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

二级目录

二级目录

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

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

相关文章

【数据结构】栈「介绍+完整代码+调试」

1.栈 1.1栈的概念及结构 栈&#xff1a;一种特殊的线性表&#xff0c;其只允许在固定的一端进行插入和删除元素操作。进行数据插入和删除操作的一端 称为栈顶&#xff0c;另一端称为栈底。栈中的数据元素遵守后进先出LIFO&#xff08;Last In First Out&#xff09;的原则。压…

潮乎新年盲盒H5版本可易支付对接

添加图片注释&#xff0c;不超过 140 字&#xff08;可选&#xff09; 潮乎新年盲盒H5版本可易支付对接 前端三十行和三十一行改成你域名百度网盘

毕设(二)——NB-IOT通信模块(nb卡通信测试)+gps定位

文章目录 一、关于接线2月1日记录2月4日记录 二、网络连接测试三、HTTP通信3.1 网络调试3.2 nb-lot的连接测试 一、关于接线 如果pico的供电能力不行&#xff0c;可能会直接用4.2V的锂电池对右下引脚进行供电 这个模块只支持nb卡&#xff0c;我哭死&#xff0c;20块钱&#xff…

第二件事 在Java 虚拟机 (JVM)跑一个程序

上篇文章写了 在 WINDOWS上 创建了一个 JVM&#xff0c; 好&#xff01; 现在在这个 Java 虚拟计算机系统上跑一个Java语言编写的小程序&#xff1b; 题目&#xff1a; 用Java语言 编写一个小程序 在Console界面 打印 整数 1-10 (回头了一下源程序&#xff0c;靠&#xff0c;应…

行人重识别综述

Deep Learning for Person Re-identification: A Survey and Outlook 论文地址https://arxiv.org/pdf/2001.04193 1. 摘要 we categorize it into the closed-world and open-world settings. closed-world&#xff1a;学术环境下 open-world &#xff1a;实际应用场景下 2…

AI专题:AI巨轮滚滚向前

今天分享的是电子系列深度研究报告&#xff1a;《AI专题&#xff1a;AI巨轮滚滚向前》。 &#xff08;报告出品方&#xff1a;方正证券&#xff09; 报告共计&#xff1a;65页 来源&#xff1a;人工智能学派 Gemini 1.5 Pro 性能显著增强&#xff0c;长上下文理解取得突破 …

SpringBoot自动注入源码分析

Spring Boot何时注入Autowired标注的属性&#xff1f; 是在Bean实例化后&#xff0c;填充Bean的时候注入Autowired标注的属性 如果注入类型的Bean存在多个&#xff0c;Spring Boot是如何处理的&#xff1f; 如果存在多个类型的Bean&#xff0c;会根据primary—>javax.ann…

我的NPI项目之Android USB 系列(一) - USB第一面

和USB应该是老朋友了&#xff0c;从2011年接触Android开发开始&#xff0c;就天天和USB打交道了。那时候还有不 对称扁头的usb/方口的usb&#xff0c;直到如今使用广泛的防反插USB3.0 type-C。 但是&#xff0c;一直有一个不是很清楚的问题萦绕在心头&#xff0c;那就是。先有…

天洑AIFEM软件将助力竞技机器人国际冠军战队再攀高峰

2023年底&#xff0c;烈鹏战队作为中国顶尖机器人队伍代表出征国际赛事Battle of Robots&#xff0c;经过与全球战队激烈竞争&#xff0c;取得国际赛场上5连胜的优秀战绩斩获国际冠军。 天洑智能结构仿真软件AIFEM与玄智科技的技术方案联合&#xff0c;基于烈鹏战队的冠军机器人…

基于shp数据制作3DTiles建筑白膜

经纬管网建模系统MagicPipe3D&#xff0c;本地离线参数化构建地下管网、建筑三维模型&#xff0c;输出标准3DTiles服务、Obj模型等格式&#xff0c;支持Cesium、Unreal、Unity、Osg等引擎加载进行三维可视化、语义查询、专题分析。欢迎下载试用&#xff1a;http://www.magic3d.…

P1824 进击的奶牛题解

题目 Farmer John 建造了一个有N&#xff08;2≤N≤105) 个隔间的牛棚&#xff0c;这些隔间分布在一条直线上&#xff0c;坐标是&#xff08;0≤​≤&#xff09;。 他的C&#xff08;2≤C≤N&#xff09;头牛不满于隔间的位置分布&#xff0c;它们为牛棚里其他的牛的存在而愤…

“比特币突破5.2万美元”,一枚币可换一斤半黄金?黄金比特币之争再次甚嚣尘上!

自今年1月美国SEC批准比特币现货ETF登陆美股市场之后&#xff0c;只用了短短的30个交易日&#xff0c;比特币ETF就从零膨胀到了近400亿美元的规模&#xff0c;超过白银ETF约100多亿美元的规模&#xff0c;和规模约为900多亿美元的黄金ETF暂时形成了“三七开”的格局。比特币现货…

毕业设计:基于知识图谱的《红楼梦》人物关系可视化

文章目录 项目介绍部署步骤项目运行 项目介绍 github地址&#xff1a;https://github.com/chizhu/KGQA_HLM?tabreadme-ov-file 基于知识图谱的《红楼梦》人物关系可视化&#xff1a;应该是重庆邮电大学林智敏同学的毕业设计&#xff0c;在学习知识图谱的过程中参考使用。 文…

ESP8266 烧录 MQTT固件

~~ 文章约定 ~~ 约定1&#xff1a;本篇所述固件&#xff0c;已测试可用于阿里云连接&#xff0c;其它云&#xff0c;未测试。 约定2&#xff1a;本烧录方法&#xff0c;以魔女开发板的板载ESP8266作示范。 约定3&#xff1a;如果使用独立的CH340、独立的ESP8266&#xff0c;请…

Puresuit 轨迹跟踪

在网上看过了很多Puresuit的轨迹跟踪算法&#xff0c;看起来都写的差不多&#xff0c;用起来不会用。 套用一份demo,在C转C语言的时候又深入理解了一些&#xff0c;在此整理成文档&#xff0c;供大家参考。输入 1.输入量是什么; 要知道车的长度&#xff0c;车的后轮位置以及下…

Redis(03)——发布订阅

基础命令 基于频道 publish channel message&#xff1a;将信号发送到指定的频道pubsub subcommand [argument [argyment]]&#xff1a;查看订阅或发布系统状态subscribe channel [channel]&#xff1a;订阅一个或多个频道的信息unsubscribe [channel [channel]]&#xff1a;退…

Leetcode 1089.复写零

目录 题目 思路 代码 题目 给你一个长度固定的整数数组 arr &#xff0c;请你将该数组中出现的每个零都复写一遍&#xff0c;并将其余的元素向右平移。 注意&#xff1a;请不要在超过该数组长度的位置写入元素。请对输入的数组 就地 进行上述修改&#xff0c;不要从函数返回…

javascript选择器大全

目录 1.getElementsByTagName 2.getElementsByName 3.getElementById 4.getElementsByClassName 5.querySelector 6.querySelectorAll 1.getElementsByTagName 俗称标签选择器&#xff0c;可以根据标签名查找匹配到页面的元素对象&#xff0c;返回为一个数组。 <div&…

google邮箱开启两步验证

我开发的chatgpt网站&#xff1a; https://chat.xutongbao.top/

美国Mercari煤炉注册教程,还不快来Get!

想要掘金全球电商市场&#xff0c;美国的Mercari平台绝对值得关注。Mercari&#xff0c;也被称作煤炉&#xff0c;类似于我们国内的闲鱼二手交易平台&#xff0c;它同时拥有美国和日本两个市场。其中&#xff0c;美国市场的消费需求稳定且持续增长&#xff0c;成为了许多跨境电…