注释对于我们写代码的一些重要性
注释的作用:
1.说明函数的功能
2.说明函数参数的意思
3.说明函数这样设计的原理(计算公式)
4.说明函数的使用场景
5.作者和日期
6.说明变量的作用
7.函数调用方法与注意事项
要注释是多么重要的一件事情啊。
所以写代码需其实注释没有特别严格的注释格式,但是为了使得注释整齐简洁。还是会有一些格式的要求的。针对不同开发平台,不同编程语言,都有各自不同的注释推荐格式。
命名基本原则
(1)命名清晰明了,有明确含义,使用完整单词或约定俗成的缩写。通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写。即"见名知意"。
(2)命名风格要自始至终保持一致。
(3)命名中若使用特殊约定或缩写,要有注释说明。
(4)同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。
宏和常量用全部大写字母来命名,词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。
变量名用小写字母命名,每个词的第一个字母大写。类型前缀(u8s8 etc.)全局变量另加前缀g_。
局部变量应简明扼要。局部循环体控制变量优先使用i、j、k等;局部长度变量优先使用len、num等;临时中间变量优先使用temp、tmp等。
函数名用小写字母命名,每个词的第一个字母大写,并将模块标识加在最前面。
一个文件包含一类功能或一个模块的所有函数,文件名称应清楚表明其功能或性质。每个.c文件应该有一个同名的.h文件作为头文件。
文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息。修改文件代码时,应在文件注释中记录修改日期、修改人员,并简要说明此次修改的目的。所有修改记录必须保持完整。文件注释放在文件顶端,用"/*……*/"格式包含。注释文本每行缩进4个空格;每个注释文本分项名称应对齐。
/***********************************************************
文件名称:
作者:
版本:
说明:
修改记录:
***********************************************************/
函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录(备注)等相关项目。函数头部注释放在每个函数的顶端,用"/*……*/"的格式包含。其中函数名称应简写为Name(),不加入、出口参数等信息。
/***********************************************************
函数名称:
函数功能:
入口参数:
出口参数:
备注:
***********************************************************/
注释加深对程序的理解。如果能够对程序中每句话加上正确合理的注释,那么说明对程序的掌握是很到位的。尤其是在自己编写程序时、或者抄别人程序时,难免会出现语法错误和现象不符,这时如果能够对每句话加以注释,就能大大加深对程序的理解,也能更快的找到问题所在。试想,对程序中的每句话都加上了清晰明了的注释,还会看不懂程序吗。在注释过程中,在哪里卡住了,或者无法做出合理的解释,那么很有可能这就是问题所在。
便于以后回看。人的记忆是有限的,一段没有注释的程序在闲置一段时间后,再次看时,可能会看不懂程序写的说什么意思。这时详细的注释就像是产品说明书,配合着注释,能够在短时间内明白程序所写的含义。
相关阅读
-
注释对于我们写代码的一些重要性
如果一个好的程序没有注释,那会是一团乱麻而且会让其他人无法更加... -
区块链带来好处的同时也存在个人信息安...
2021年11月,工信部正式复函,支持苏州创建全国首个区块链发展先导... -
智慧医疗得到了前所未有的成长前景日益广阔
随着人工智能的发展,在医疗界中的应用也越来越广泛,智能医疗在未... -
蔚来汽车创始人李斌卸任嘀嗒出行董事
4月18日消息,据天眼查显示,近日,嘀嗒出行关联公司北京畅行信息技... -
我国最新固定宽带网络平均下载速率出炉
今日,据“中国信通院CAICT”微信公众号消息,宽带发展联盟日前发布... -
创历史性新高!比亚迪Q1利润涨幅可达300%
4月18日晚,比亚迪发布了2022年Q1季度业绩预告,公司预计2022年第一...
精彩推送
-
智慧医疗得到了前所未有的成长前景日益广阔
随着人工智能的发展,在医疗界中的应用也越来越广泛,智能医疗在未... -
吉利全新电动SUV内饰官图发布:配10.25...
吉利全新电动SUV内饰官图发布:配10 25英寸大屏、有两块! -
注释对于我们写代码的一些重要性
如果一个好的程序没有注释,那会是一团乱麻而且会让其他人无法更加... -
区块链带来好处的同时也存在个人信息安...
2021年11月,工信部正式复函,支持苏州创建全国首个区块链发展先导... -
苏A牌照摩托车起拍2千超160万落锤 摩友...
苏A牌照摩托车起拍2千超160万落锤摩友:估价最多不超过20万 -
4.6%高息存款被限制后,多家民营银行“...
在监管下令压降靠档计息产品、清退智能存款产品后,高息存款产品已... -
部分券商被传“不得弃购新股”,如何避...
近期,部分券商被传不得弃购新股,有的股民打新中签之后,连放弃缴... -
一天之内,招商银行行长变动冲上热搜
一天之内,招商银行因股价下跌、行长变动接连冲上微博热搜榜单。在... -
加氢气后车主摸油箱盖起火!现代召回多...
加氢气后车主摸油箱盖起火!现代召回多款氢燃料车型 -
年轻人又一台入门“小钢炮” 吉利缤瑞C...
年轻人又一台入门“小钢炮”吉利缤瑞COOL开启预定:9 58万元起 -
新能源销量全国第一!比亚迪发一季度业...
新能源销量全国第一!比亚迪发一季度业绩预告:净利最高暴增300% -
我国最新固定宽带网络平均下载速率出炉
今日,据“中国信通院CAICT”微信公众号消息,宽带发展联盟日前发布... -
蔚来汽车创始人李斌卸任嘀嗒出行董事
4月18日消息,据天眼查显示,近日,嘀嗒出行关联公司北京畅行信息技... -
奇瑞设计师巅峰之作!全新轿车艾瑞泽8官...
奇瑞设计师巅峰之作!全新轿车艾瑞泽8官图公布:车身满是奥迪味 -
宁德时代EVOGO换电服务首次在厦门启动
4月18日,从宁德时代官方获悉,宁德时代EVOGO换电服务已在厦门正式... -
酷派与腾讯云签署战略合作协议,探索下一...
4月18日,酷派集团与腾讯云在深圳签署战略合作协议,双方将成立联合... -
创历史性新高!比亚迪Q1利润涨幅可达300%
4月18日晚,比亚迪发布了2022年Q1季度业绩预告,公司预计2022年第一... -
更少分心的通知,Google正在试验一系列设备
据BGR报道,Google正在试验一系列设备,以实现更少分心的通知。这些... -
Win11升级时弹出0xc1900101报错,微软回应
对于不少Win10的老用户来说,0xc1900101应该都是印象深刻的一个报错... -
比亚迪:一用户长期诋毁比亚迪 被判赔...
比亚迪:一用户长期诋毁比亚迪被判赔礼道歉并赔3万块 -
骁龙电竞先锋赛中国赛,4月18日开启移动...
2022年4月12日—ESLGaming此前宣布联合高通技术公司为全球玩家带来... -
北京首位驾驶员通过C6考试:可驾驶轻型...
北京首位驾驶员通过C6考试:可驾驶轻型牵引挂车了 -
颜值和动力在线!飞凡汽车首款旗舰车型...
近日,我们在最新一批工信部新车申报目录中,发现了飞凡汽车首款旗... -
集度正式发布首款汽车机器人概念车,双...
4月18日,集度正式发布首款汽车机器人概念车车头部位的设计细节,车... -
62.55Mb/s!我国最新固定宽带网络平均下...
今日,据“中国信通院CAICT”微信公众号消息,宽带发展联盟日前发布... -
数据显示:亚太地区将引领全球电池储能...
据国外媒体报道,数据分析公司GlobalData最新发布的一份报告显示,... -
搭载联发科天玑700处理器,三星电子将采...
据BusinessKorea报道,三星电子已将Exynos 850应用处理器(AP)用于... -
科大讯飞已申请车辆安全监控专利
小时候看新闻时,总能听到有出租车司机被歹徒绑架的案件,有些歹徒... -
移远通信:2021年净利润3.58亿元,同比...
日前,移远通信发布2021年年度报告。2021年,移远通信实现营业收入1... -
海康威视2021年实现净利润168亿元 同比...
日前,海康威视发布2021年年度报告。报告期内,海康威视实现营业总... -
iPhone 15有望配备潜望式摄像头 供应...
据国外媒体报道,分析师此前曾预计,苹果明年将推出的iPhone15系列... -
iPhone14Pro效果图曝光:“感叹号”挖孔...
综合目前传闻来看,iPhone 14 Pro将改为挖孔屏的事实已经基本确定... -
2021年Q4我国固定宽带用户平均网络下载...
根据宽带发展联盟发布的报告显示,2021年第四季度,我国固定宽带用... -
截至3月底,全国增值电信业务经营许可企...
中国信通院日前发布《国内增值电信业务许可情况报告(2022 3)》。... -
Google正在试验一系列设备 以实现“更...
据BGR报道,Google正在试验一系列设备,以实现“更少分心的通知”。... -
三大运营商2021年Q4固定宽带平均下载速率对比
根据宽带发展联盟发布的报告显示,2021年第四季度,三家基础电信企... -
打击AI换脸 微软、Intel等将推新技术:...
AI人工智能被认为是可以改变人类社会的技术之一,各种人脸识别的应... -
零百加速四秒级!飞凡R7工信部公示:换...
近日,我们在最新一批工信部新车申报目录中,发现了飞凡汽车首款旗... -
美光16Gb容量GDDR6X 内存宣布量产
4月18日消息,美光宣布量产全新的16Gb容量GDDR6X内存,并已搭载于NV... -
移远通信2021年实现净利润3.58亿元 同...
日前,移远通信发布2021年年度报告。2021年,移远通信实现营业收入1... -
西部数据发布全新品牌标识
据西部数据官微消息,今日西部数据正式发布全新品牌标识。不过目前... -
保命装置成“摆设”!丰田召回46万辆车...
保命装置成“摆设”!丰田召回46万辆车:VSC系统不工作 -
售价近6000元旗舰又翻车!曝谷歌Pixel ...
近日,根据一部分用户在Reddit反馈的消息,谷歌Pixel6系列出现了一... -
1099元起!OPPO A55s发布:系统30个月流畅无压力
今日,OPPOA系列新成员——OPPOA55s正式发布,新机目前已在OPPO官网... -
Win11首个重大更新!Win 11 22H2系统...
Win11系统发布已经半年了,微软之前表示一年只会大版本升级一次,所... -
Windows 11默认浏览器更改困难被人吐槽...
在最新的Windows11版本中,更改系统的默认浏览器比以往任何时候都更容易。 -
烽火通信2021年实现净利润约2.88亿元 ...
日前,烽火通信发布2021年年度报告。 -
微软成立安卓体验部门 将进一步整合Win...
据国外媒体报道,微软已经证实,正在将其Android工作整合到一个名为... -
消息称苹果今年9月行动:欲放弃一代神机...
作为一代神机,iPhone11系列应该很快被苹果彻底放弃,这也是为自家S... -
七年前老问题卷土重来!Win11再现0xc190...
对于不少Win10的老用户来说,0xc1900101应该都是印象深刻的一个报错... -
集度首款汽车机器人曝光:双激光雷达 ...
在去年年度举办的百度Create2021(百度AI开发者大会)上,李彦宏表... -
碰瓷保时捷 “国产新能源天花板”学贾...
碰瓷保时捷“国产新能源天花板”学贾跃亭割韭菜 -
中国造豪华车 不能光靠嘴炮
中国造豪华车不能光靠嘴炮 -
奥迪史上最大SUV!上汽奥迪Q6预告图公布...
奥迪史上最大SUV!上汽奥迪Q6预告图公布:灵感来自中国神话麒麟 -
终于等到!全固态电池有望在三年内商业...
终于等到!全固态电池有望在三年内商业化:续航 快充大提升 -
逐渐“果化”?马斯克证实特斯拉将不再...
逐渐“果化”?马斯克证实特斯拉将不再赠送移动充电器 -
搭载双激光雷达 集度首款汽车预告 李...
搭载双激光雷达集度首款汽车预告李想:性能和车顶单颗没区别、甚至不如 -
中石化回应油价“国际降你不降 你和国...
中石化回应油价“国际降你不降你和国际不一样”:真是误解了 -
彻底停止燃油车 比亚迪Q1利润涨幅可达3...
彻底停止燃油车比亚迪Q1利润涨幅可达300%:新能源创新高 -
罗永浩:我给你做一个触及灵魂、荡气回...
4 月 16 日晚间,针对粉丝是否可以再做一款手机的提问,锤子手机... -
P7自动辅助驾驶撞车!车主:曾退订特斯...
P7自动辅助驾驶撞车!车主:曾退订特斯拉买小鹏这次属实寒心 -
疑似新款比亚迪海豚曝光:屁股改了
疑似新款比亚迪海豚曝光:屁股改了 -
车主曝特斯拉“踩刹车”前进掉河!网友...
车主曝特斯拉“踩刹车”前进掉河!网友:车尾车贴已说明原因 -
搭载混动系统 广汽传祺EMKOO前脸曝光:...
搭载混动系统广汽传祺EMKOO前脸曝光:超酷机甲风! -
后排不系安全带危害有多大?IIHS实测:...
后排不系安全带危害有多大?IIHS实测:能害死前排乘客 -
分析师预计三星9月份开始销售搭载LG面板...
4月18日消息,据国外媒体报道,有分析师预计,三星电子在今年9月份... -
颜值不输特斯拉!哪吒S全曝光:零百加速...
颜值不输特斯拉!哪吒S全曝光:零百加速3 9秒比肩超跑 -
网信办:今年3月全国受理网络违法和不良...
据网信办官网通报,2022年3月全国受理网络违法和不良信息举报1258 ... -
凯柏胶宝® 与 Pune Polymers 合作...
凯柏胶宝®是全球领先的TPE制造商,针对各行各业提供TPE产品和定制... -
凯柏胶宝® TPE提高电子消费品的人体工学性能
凯柏胶宝®正积极开发适用于电子消费品的TPE解决方案,以满足市场对... -
打方向不会回正!奔奔E-Star车主集体投...
打方向不会回正!奔奔E-Star车主集体投诉长安汽车 -
比加油还方便 宁德时代换电服务首次落...
比加油还方便宁德时代换电服务首次落地:月租金最低399元 块 -
微软自曝Windows 11重大更新23H2:功能改进明显
微软已经暗示接下来的Windows11重大更新细节,其代号为“SunValley3... -
英威腾二十周年 聚力创未来
20年来,英威腾始终专注于工业自动化和能源电力两大领域,以"竭尽全... -
特斯拉公布全新巨型360MWh Megapack项目
特斯拉已经公布了它最新的巨型Megapack项目--拥有360MWh的储能能力... -
用友汽车拟在科创板上市 预计今年上半...
用友网络发布关于分拆所属子公司用友汽车至科创板上市的进展公告,... -
大疆最新无人机谍照泄露!大疆无人机为何...
一直以来,大无人机都是大家的关注焦点之一。因此针对大家的兴趣点... -
华为合作的AITO问界M5迎来首次OTA升级
AITO官方宣布,问界M5现已开始推送首次OTA升级,版本号为V1 0 102SP05。 -
中国电信变更定制化波分设备委托代工项目
日前,中国电信启动波分设备定制化(2022年)采购项目资格预审工作... -
证监会:滴滴自主退市系特定个案 与其...
针对滴滴发布自美退市相关公告一事,证监会回应称,这是企业根据市... -
一季度全国快递服务企业业务量累计完成2...
据国家邮政局发布的数据,一季度,全国快递服务企业业务量累计完成2... -
报道称字节跳动以每股142美元回购期权
据界面新闻报道,字节跳动已于4月15日沟通年终绩效,并以每股142美... -
网信办等三部门:从严整治“网红账号”...
据网信办官网消息,按照2022年“清朗”系列专项行动安排,中央网信... -
直行特斯拉撞上左转雪铁龙后起火:烧的...
直行特斯拉撞上左转雪铁龙后起火:烧的只剩下空壳 -
全系搭载骁龙888!OPPOK10系列渲染图曝光
按照目前已知消息,OPPO将会在下周召开一场新品发布会,正式推出OPP... -
零百加速四秒级!飞凡R7工信部公示:换...
零百加速四秒级!飞凡R7工信部公示:换电技术上车 -
三星2021年旗舰!官翻版Galaxy S21系列...
4月18日消息,三星GalaxyS21系列是三星2021年推出的年度旗舰,如今... -
微软憋大招:Windows 11、安卓要深度结...
对于微软来说,继续发展Windows11的同时,还要加强这个系统与安卓的联动。 -
TCL雷鸟发布鹏6系列游戏电视:金属全面...
关注电视的小伙伴,这几年对雷鸟这个品牌一定不会陌生,作为TCL的子... -
微软暗示将进一步整合Windows 11和Android系统
在一份新的职位列表中,微软已经证实它正在将其Android工作整合到一... -
Office Version 2204最新预览版发布:...
面向Current频道的订阅用户,微软今天发布了OfficeVersion2204(Bui... -
海康威视第一季度营收165亿元 净利润22.84亿元
海康威视公布2022年第一季度业绩报告,报告显示,公司第一季度营收1... -
超越保时捷Taycan 智己L7创新吉尼斯纪录
吉尼斯世界纪录多种多样,其中有一项是保时捷Taycan取得的,名为“... -
代号“Sun Valley 3” 微软暗示Windo...
在多份微软官方支持文档中提及“Version23H2”功能更新之后,在最新... -
Twitter正测试推文编辑按钮 将首先提供...
据PhoneArena报道,你有没有遇到过这种情况:你正在撰写一条推文,... -
英特尔称其检测学生情绪的AI为教学工具
据Protocol报道,当大学教师AngelaDancey想要解读她的大一英语学生... -
卡皇中的卡皇!影驰RTX 3090 Ti名人堂...
RTX3090Ti是名副其实的卡皇,各家的顶级非公版自然是卡皇中的卡皇,... -
华为AITO问界M5迎首个OTA升级:迎宾座椅
AITO官方宣布,问界M5现已开始推送首个OTA升级,版本号为V1 0 102SP05。 -
iPhone最重要制造厂!消息称郑州富士康...
郑州富士康一直以来都是个苹果iPhone手机最重要的制造厂,是也是最... -
比Xbox One更好卖!微软XSX/S全球销量超1386万台
2020年11月10日,微软XboxSeriesX S正式发售,数据显示,XboxSerie...