0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

对于代码规范的一些总结

GReq_mcu168 来源:玩转单片机 2019-12-08 10:21 次阅读

作为一个程序员,肯定希望能写出一手好代码,看起来赏心悦目,又易于理解。虽说好的代码是在一定代码量的基础上积累起来的,但在写代码之初就应该有意识地去遵循一定的规范。

以下是两位工程师对于代码规范的一些总结,很有代表性,分享给大家。+



代码不是一次性的,要为未来写代码

最近的几件事情让我对代码规范的重要性有了更深的体会,决定自己做些总结。
情景一:一个不大的项目,由几个人共同完成。某日,由于业务需求变更,需要改动我这边的部分逻辑,但当时我不在,项目组的成员决定由他们来改,但翻了我的代码,硬是没找到该逻辑在哪实现的^_^。后来听了他们的描述,很伤……
情景二:负责一个项目的源代码流程测试,一期代码并非模块化实现,6K多的shell脚本即使有注释,看着那个头疼,后来在我们提出该问题后,开发重新进行了设计和规范,拿到代码的那一刻顿时感觉清晰多了。
都说代码是程序员的第二张脸,长时间下来,写的好的代码定会受到大家的尊重。遵循一些简单的规范,写干净一致的代码!把个性用在写出最简单易懂的代码上面,而不是晦涩冗余无用的代码,甚至自我签名!设计良好的结构和模式,撰写干净易懂的代码,对空间的尊重,对代码的尊重。这样能赢得别人的尊重!记住代码不是一次性的,需要重复的修改和重构,为未来写点代码!
1,写干净整洁的代码
1.1 代码格式化,包括多级代码缩进、大括号(比如C系代码),为了提高代码的美观型和易读性,区间与区间之间最好以一行*或-之类的间距;
1.2 合理运用空行。空行可以用来隔开相对独立的代码块,有利于阅读和理解。但是不要使用超过一行的空行,对空间,别太奢侈了;
2,命名规范命名包括函数、变量、类(面向对象中)、命名空间等;
2.1命名需要遵循由其命名便知道其意义的原则; 变量命名区分全局变量、导出变量、常量、局部变量,最好区分类型(如果有的话);
2.2 可采用业界的一些命名规范,比如匈牙利命名,但同一个项目必须统一;
3,高效使用注释
3.1 注释代码段,注释逻辑选择。上面提到运用空行分割开逻辑相对独立的代码,那么请在空行的下一行也写点下面代码段要干什么的语句吧。如果有if else等逻辑选择的时候,麻烦也花几秒钟写上判断的依据和结果好吗?逻辑难懂且关键,您懂的!
3.2 为不容易理解类变量注释。类变量特别是私有的类变量没有人要求注释,但是为了能够快速的了解您表示的是什么,还是写点什么吧!您知道我英文不算好!
3.3 独立的代码模块、文件、函数需要撰写注释以说明其实现意图、原理、怎么使用等(比如函数的输入输出参数等),独立的代码文件和模块(比如类)最好写上作者、日期、联系方式、版本号等信息,以便后期做追踪;
3.4 并不是注释越多越好,相反,完全模块化、结构化的程序很多地方注释完全可以精简;
4,程序结构化、模块化
4.1 程序设计中有很多原则、设计模式,不同的语言、不同的情景可能会有些差异,但整体需要支持高类聚、低耦合的设计实现方案;
4.2 养成写开发文档的习惯。对于每一个页面设计(前接页,后接页),包括功能说明,页面设计,页面名称,存放位置等,应当有相应的文档记载。对于发生改动的地方,需要保留原来的部分(注释或备份),并说明备份文件存放的地方,改动时间,修改人;对于程序部分,应该有相应的设计流程,改动的时候,也需要设计改动流程图,以便以后进行对比,和查找问题所在位置,以及问题的严重性分析。
4.3 始终要记住的是你写出的代码并不是给你一个人看的,你需要保证你的代码清晰、一致,别的程序员能够读懂,团队里面最好定期有code review环节。
5,多读优秀的源代码、多实践
5.1 看别人代码时要汲取好的方法和技巧。
5.2 接触一项技术要深入了解和实践,请问您做过的系统您现在都可以从零开始搭建起来了吗,我的意思是架构搭建哦!(以上部分内容摘自https://blog.csdn.net/bullbat/article/details/9265351,作者:bullbat)

代码写多了,总结出适合自己的代码风格
1、类型的宏替换1)要求要求用“#ifndef”判断是否之前被定义过。2)举例

#ifndef GUA_U8

typedef unsigned char GUA_U8;

#endif

#ifndef GUA_U16

typedef unsigned short GUA_U16;

#endif

#ifndef GUA_U32

typedef unsigned long GUA_U32;

#endif

2、宏定义1)要求①宏全为大写的英文字母。 ②宏的名称应能读出其功能作用。2)举例

#define GUA_RF_COMMUNICATION_JUDGMENT_FALSE 0

#define GUA_RF_COMMUNICATION_JUDGMENT_TRUE 1

3、变量1)要求①变量名称前的字母含义要求如下 g:global全局。 a:array数组。 s:static静态。 c:const不变常数。 n:变量。 p:指针。 ②变量的名称应能读出其功能作用。2)举例

GUA_U8 gaGUA_USART1_rx_buf[GUA_USART1_RX_SIZE] = {0};//全局数组

GUA_U8 gnGUA_USART1_rx_buf = 0;//全局变量

GUA_U8 nGUA_USART1_rx_buf = 0;//局部变量

static GUA_U8 snGUA_USART1_rx_buf = 0;//静态变量

const static GUA_U8 csnGUA_USART1_rx_buf = 0;//const类型的静态变量

GUA_U8 *gpGUA_USART1_rx_buf; //全局指针

3、if1)要求①“{”与“}”要对齐。 ②if与else的上方要注释。2)举例

//如果计数值大于10,则返回true

if(nGUA_Num > 10)

{

return true;

}

//如果计数值小于10,则返回false

else

{

return false;

}

4、switch1)要求①switch、case、default上都要注释。 ②每种情况的具体处理由“{}”包含。2)举例

//如果为0则关灯

switch(nbGUA_Char6[3])

{

//关灯

case 0x00:

{

P1_1 = 0; //拉低P11

P1SEL &= ~(1 << 1); //设置P11为IO口

P1DIR |= (1 << 1); //设置P11为输出

break;

}

//开灯

case 0x01:

{

P1_1 = 1; //拉高P11

P1SEL &= ~(1 << 1); //设置P11为IO口

P1DIR |= (1 << 1); //设置P11为输出

break;

}

//其它

default:break;

}

5、文件及函数注释1)文件注释要求至少要包含文件名称、文件作用说明、编码人、最后修改时间。2)函数注释要求至少要包含函数名称、函数作用说明、形参含义、返回值含义、编码人、最后修改时间。

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 函数
    +关注

    关注

    3

    文章

    4350

    浏览量

    63078
  • 代码
    +关注

    关注

    30

    文章

    4841

    浏览量

    69225

原文标题:如何写出好代码?附资深码农的个人代码规范

文章出处:【微信号:mcu168,微信公众号:硬件攻城狮】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    评论

    相关推荐

    AN29-关于DC-DC转换器的一些想法

    电子发烧友网站提供《AN29-关于DC-DC转换器的一些想法.pdf》资料免费下载
    发表于 01-08 13:57 0次下载
    AN29-关于DC-DC转换器的<b class='flag-5'>一些</b>想法

    一些关于ldc1000的spi通信的问题求解

    我有一些关于ldc1000的spi通信的问题。 应用情况是spi16f887与ldc1000的spi通信 1.是否对于读、写,都是只需要把CSB变成低电平即可。 2.对于写操作,写地址时(例如
    发表于 12-26 08:23

    Java代码之美,从遵循样式规范开始

    至关重要。本文将带你探索Java代码的美学,揭示那些能够让你的代码既美观又高效的样式规范。无论是初出茅庐的新手还是经验丰富的老手,都能从中获得灵感,提升编码的艺术。 、为什么要
    的头像 发表于 11-27 11:42 288次阅读
    Java<b class='flag-5'>代码</b>之美,从遵循样式<b class='flag-5'>规范</b>开始

    一些常见的动态电路

    无论是模电还是数电,理论知识相对来说还是比较枯燥,各种电路原理理解清楚不算容易,换种生动形象的方式或许会增加一些趣味性,也更容易理解这些知识。下面整理了一些常见的电路,以动态图形的方式展示。 整流
    的头像 发表于 11-16 09:26 547次阅读
    <b class='flag-5'>一些</b>常见的动态电路

    分享一些常见的电路

    理解模电和数电的电路原理对于初学者来说可能比较困难,但通过一些生动的教学方法和资源,可以有效地提高学习兴趣和理解能力。 下面整理了一些常见的电路,以动态图形的方式展示。 整流电路 单相桥式整流
    的头像 发表于 11-13 09:28 443次阅读
    分享<b class='flag-5'>一些</b>常见的电路

    LED驱动器应用的一些指南和技巧

    电子发烧友网站提供《LED驱动器应用的一些指南和技巧.pdf》资料免费下载
    发表于 09-25 11:35 0次下载
    LED驱动器应用的<b class='flag-5'>一些</b>指南和技巧

    关于一些有助于优化电源设计的新型材料

    众所周知,人们对更高电源效率的追求正在推动性能的全方位提升。材料科学的进步对于优化电源设计和开发更高效、更紧凑和更可靠的解决方案发挥着关键作用。下文列出了一些有助于优化电源设计的新材料。
    的头像 发表于 08-29 15:26 522次阅读

    二进制处理中的一些技巧

    在二进制和十进制的处理中,有时候一些小技巧是很有用的。 1、把十进制数转换成二进制数 (1)在MATLAB中有个函数dec2bin,可以把正整数转换为2进制 (2)对于负数有这样
    的头像 发表于 07-05 11:51 649次阅读

    咨询一些关于LED灯具的问题

    各位大佬,咨询一些关于LED灯具的问题 120W的吸顶灯,用的非隔离式电源,用不到1年,灯具就会闪烁、频闪或不亮,主要是什么原因造成的?是不是驱动芯片太差?
    发表于 07-02 22:33

    华为PCBA检查规范设计总结

    福利来啦! 给大家分享《华为PCBA检查规范设计总结
    的头像 发表于 06-15 16:25 2289次阅读
    华为PCBA检查<b class='flag-5'>规范</b>设计<b class='flag-5'>总结</b>

    细谈SolidWorks教育版的一些基础知识

    SolidWorks教育版是款广泛应用于工程设计和教育领域的三维建模软件。它具备直观易用的操作界面和强大的设计功能,为学生提供了个学习和实践的平台。在本文中,我们将详细探讨SolidWorks教育版的一些基础知识,帮助初学者
    的头像 发表于 04-01 14:35 419次阅读

    PLC常用专业英文词汇翻译总结

    PLC编程中我们经常会遇到一些专业英文词汇,对于入门的学员来说过理解起来是非常困难的。本文总结一些PLC常用专业英文词汇,并做已翻译。
    的头像 发表于 03-19 11:40 2601次阅读

    关于DPDK的一些常见问题

    对于单核多CPU部署,个CPU分配给操作系统,另个分配给基于DPDK的应用程序。对于多核部署,无论是否使用超线程,都可以为每个端口分配多个内核。
    的头像 发表于 03-05 11:44 971次阅读
    关于DPDK的<b class='flag-5'>一些</b>常见问题

    一些有关通信电路的资料?

    有关嵌入式之间DSP、ARM、FPGA三者之间和这三款芯片和外部电路之间通信的一些资料,比如说芯片之间的并行通信和芯片和外部电路之间的串行通信,MODBUS、DP、CAN等,一些一些常用的通信协议的
    发表于 03-03 18:53

    对于绘制USB DRP架构的一些疑问求解

    我正在绘制新系统的架构,对此有一些疑问: 1) 通常左侧板有 20V 固定电源,将通过 TypeC 端口向右板提供 20V。 a) Vbus 通过 Mosfets 直接连接到 20V,如果谈判失败
    发表于 02-23 06:31