热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

养成良好的Linux编码风格

文章标题:养成良好的Linux编码风格。Linux是中国IT实验室的一个技术频道。包含桌面应用,Linux系统管理,内核研究,嵌入式系统和开源等一些基本分类

    Linux操作系统是一个开源的操作系统,为此你在Linux系统上开发的一个工具软件,包括源代码,可能其他系统管理员也需要用到。为此在编写代码的时候,就需要遵守一定的规则。这不仅是为了方便他人的阅读,也是为了以后自己的维护与升级考虑。具体的来说,笔者认为Linux系统管理员要养成下面的一些好的编码风格。

  一、 合理防治函数开头的左花括号。

  根据大部分系统管理员认可的编码风格,往往将函数开头的左括号放到代码页的最左边。要避免将其他的括号(包括左花括号、左括号或者左方括号)放到最左边。这主要是为了便于阅读。因为函数的主体内容往往是有一对花括号括起来的。如果在代码页的最左边只有代表函数的花括号,那么就可以一目了然的看到函数的主体。为此这是提高代码阅读性的一个很好的手段。

  需要注意的是,这可能跟其他语言的编程风格有所差异。如在Java语言或者C语言平台上,往往将函数主体开头的花括号放在函数的后面。如在main函数后面会直接使用{这个左花括号。不过这不利于程序的阅读,不利于Linux系统管理员找到函数的主体代码。为此如果有其他编程语言使用经验的系统管理员,最好能够改变这种书写习惯。笔者建议,系统管理员还是要将这个花括号放在最左边,并保证在整个代码中,最左边出现的花括号都是代码函数主体的花括号。

  二、 每个函数开头最好都有一个简短的代表功能的说明。

  在Linux的功能代码中,其各个功能也都是一个个函数或者程序构成的。也就是说,在一个代码文件中,可能会有很多个函数构成。那么这些函数主要用来实现什么功能呢?如果不做任何说明的话,那么只有看完函数的全部代码之后才能够了解这个信息。这对于他人阅读源代码会造成比较大的障碍。而且,时间久了之后,可能连系统管理员自己都不知道这个函数时用来实现什么功能的。这对于其后续维护与升级显然是不利的。为此笔者建议各位系统管理员,无论是为自己还是为他人,最好在每个函数或者程序的开头都写上一小段注释。好记性不如烂笔头,这对于提高代码的易读性。另外需要说明的是,由于Linux系统可能对中文的支持并不是很好,为此在写这个注释的时候,最好采用英文书写。因为在一些对中文支持并不是很好的系统中,这个中文会显示为乱码,此时就起不到应有的作用了。如果不懂英文的话,那么可能只有使用拼音了。当然这只是笑话。一般Linux系统工程师对于英文需要一定的了解。因为Linux操作系统中的帮助文档都是英文写的。所以这个英文的语言关也是系统管理员必须要解决的关口。

  另外在对函数进行说明时,最好还需要著名这个函数需要用户传入什么参数,会返回什么样的结果。以及参数、结果的个数等等。这对于代码的编译与维护非常有帮助。而且项目团队中的其他成员如果要引用你这个函数的话,那么不需要查看函数的具体代码。而只需要查看一些这个注释,就可以知道需要传递进去哪些参数。这也是提高项目合作效率的一个手段。

  三、 If语句使用要规范。

  在Linux系统中编写代码时,IF语句是使用的最多的结构之一。这个if语句主要用来实现一些逻辑的判断。虽然这个语句本身比较简单,但是在使用这个语句时,最好也能够遵守一些规则。虽然这些规则主要是从易读性的角度去考虑的,但是对于编写一个准确的IF结构语句也有所帮助。

  如根据Linux系统的编程习惯,最好不要在IF的条件中进行赋值。IF语句需要根据某个条件来进行判断该采取什么样的操作。在这个条件中,根据语法是可以在这个条件中对变量进行赋值的。但是这不符合Linux系统下的编程风格。笔者建议,最好在IF结构外部对变量进行赋值,然后再在条件中直接使用这个变量。这更易于控制IF结构。另外,如果在IF语句中使用嵌套的话,可以使用花括号将嵌套的IF ELSE语句括起来,以利于发现这个嵌套语句。在其他应用程序编写过程中,是使用缩进的方式来凸现IF嵌套结构的。但是Linux系统管理员更加喜欢使用花括号。虽然这两个没有实质上的区别,但是笔者还是建议采用花括号。因为这是一个Linux操作系统业内普遍认可的一个编码风格。

  四、 大小写书写要规范。

  虽然函数名或者变量名采用大写字符或者小写字符都是允许的。但是在定义这些名字的时候,大小写最好还是要符合一些常见的规则。如对于函数的名字最好使用小写的英文字符。如果有多个单词构成的话,最好使用下划线来进行分割。而不是采用第一个英文单词大写的方式。大小写混用在某些环境中或许是很不错的解决方式,但是在Linux系统中不行。而对于变量来说,要根据变量的类型来确定使用小写字符还是采用大写字符。一般情况下,如果是系统管理员自己定义的变量,那么最好使用小写字符。如果采用的是系统变量的话,那么可以使用大写的英文字母。如此的话,一看到变量的大写还是小写的状态,就可以判断使用的是用户自定义变量还是系统变量。另外在Linux系统中也需要用到一些常量。根据大家的编程习惯,往往利用大写字符来定义常量。如系统管理员在学习其他高手编写的代码过程中,可以发现在枚举或者宏中都是利用大写字符来代表常量的。

  在确定使用大写还是使用小写字符之前,需要明确的一点就是在Linux操作系统中大小写是敏感的。也就是说,Name与name是代表两个不同的变量。为此在系统中规范大小写的格式就显得尤其的重要。由于大小写敏感,所以在同一个名字中混用大小写会让变量或者函数的应用变得很复杂。故如果一个名字有好几个单词构成,那么系统管理员要习惯利用下划线来进行单词的分割,而不是采用第一个单词大写的形式。

[1] [2] 下一页


推荐阅读
  • 学习SLAM的女生,很酷
    本文介绍了学习SLAM的女生的故事,她们选择SLAM作为研究方向,面临各种学习挑战,但坚持不懈,最终获得成功。文章鼓励未来想走科研道路的女生勇敢追求自己的梦想,同时提到了一位正在英国攻读硕士学位的女生与SLAM结缘的经历。 ... [详细]
  • Python语法上的区别及注意事项
    本文介绍了Python2x和Python3x在语法上的区别,包括print语句的变化、除法运算结果的不同、raw_input函数的替代、class写法的变化等。同时还介绍了Python脚本的解释程序的指定方法,以及在不同版本的Python中如何执行脚本。对于想要学习Python的人来说,本文提供了一些注意事项和技巧。 ... [详细]
  • 本文介绍了Linux Shell中括号和整数扩展的使用方法,包括命令组、命令替换、初始化数组以及算术表达式和逻辑判断的相关内容。括号中的命令将会在新开的子shell中顺序执行,括号中的变量不能被脚本余下的部分使用。命令替换可以用于将命令的标准输出作为另一个命令的输入。括号中的运算符和表达式符合C语言运算规则,可以用在整数扩展中进行算术计算和逻辑判断。 ... [详细]
  • 恶意软件分析的最佳编程语言及其应用
    本文介绍了学习恶意软件分析和逆向工程领域时最适合的编程语言,并重点讨论了Python的优点。Python是一种解释型、多用途的语言,具有可读性高、可快速开发、易于学习的特点。作者分享了在本地恶意软件分析中使用Python的经验,包括快速复制恶意软件组件以更好地理解其工作。此外,作者还提到了Python的跨平台优势,使得在不同操作系统上运行代码变得更加方便。 ... [详细]
  • OO第一单元自白:简单多项式导函数的设计与bug分析
    本文介绍了作者在学习OO的第一次作业中所遇到的问题及其解决方案。作者通过建立Multinomial和Monomial两个类来实现多项式和单项式,并通过append方法将单项式组合为多项式,并在此过程中合并同类项。作者还介绍了单项式和多项式的求导方法,并解释了如何利用正则表达式提取各个单项式并进行求导。同时,作者还对自己在输入合法性判断上的不足进行了bug分析,指出了自己在处理指数情况时出现的问题,并总结了被hack的原因。 ... [详细]
  • 31.项目部署
    目录1一些概念1.1项目部署1.2WSGI1.3uWSGI1.4Nginx2安装环境与迁移项目2.1项目内容2.2项目配置2.2.1DEBUG2.2.2STAT ... [详细]
  • 这篇文章主要介绍了Python拼接字符串的七种方式,包括使用%、format()、join()、f-string等方法。每种方法都有其特点和限制,通过本文的介绍可以帮助读者更好地理解和运用字符串拼接的技巧。 ... [详细]
  • 本文介绍了在Windows系统上使用C语言命令行参数启动程序并传递参数的方法,包括接收参数程序的代码和bat文件的编写方法,同时给出了程序运行的结果。 ... [详细]
  • 树莓派语音控制的配置方法和步骤
    本文介绍了在树莓派上实现语音控制的配置方法和步骤。首先感谢博主Eoman的帮助,文章参考了他的内容。树莓派的配置需要通过sudo raspi-config进行,然后使用Eoman的控制方法,即安装wiringPi库并编写控制引脚的脚本。具体的安装步骤和脚本编写方法在文章中详细介绍。 ... [详细]
  • C语言判断正整数能否被整除的程序
    本文介绍了使用C语言编写的判断正整数能否被整除的程序,包括输入一个三位正整数,判断是否能被3整除且至少包含数字3的方法。同时还介绍了使用qsort函数进行快速排序的算法。 ... [详细]
  • 本文介绍了使用Python解析C语言结构体的方法,包括定义基本类型和结构体类型的字典,并提供了一个示例代码,展示了如何解析C语言结构体。 ... [详细]
  • C语言常量与变量的深入理解及其影响
    本文深入讲解了C语言中常量与变量的概念及其深入实质,强调了对常量和变量的理解对于学习指针等后续内容的重要性。详细介绍了常量的分类和特点,以及变量的定义和分类。同时指出了常量和变量在程序中的作用及其对内存空间的影响,类似于const关键字的只读属性。此外,还提及了常量和变量在实际应用中可能出现的问题,如段错误和野指针。 ... [详细]
  • 全面介绍Windows内存管理机制及C++内存分配实例(四):内存映射文件
    本文旨在全面介绍Windows内存管理机制及C++内存分配实例中的内存映射文件。通过对内存映射文件的使用场合和与虚拟内存的区别进行解析,帮助读者更好地理解操作系统的内存管理机制。同时,本文还提供了相关章节的链接,方便读者深入学习Windows内存管理及C++内存分配实例的其他内容。 ... [详细]
  • 本文介绍了200个经典c语言源代码,包括函数的使用,如sqrt函数、clanguagefunct等。这些源代码可以帮助读者更好地理解c语言的编程方法,并提供了实际应用的示例。 ... [详细]
  • 本文讲述了作者从最初对软件工程的选择迷茫到逐渐喜欢并坚持学习的经历。作者在大学期间通过学习专业课和参与项目开发,不断挑战自己并取得成就感。虽然曾考虑过转专业和复读,但最终决定坚持学习软件工程,并为自己的未来努力奋斗。作者还提到了大学生活与自己最初的预期不同,但对此并没有太多抱怨。 ... [详细]
author-avatar
小--巍巍
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有