编程人员应该注意的代码风格

今天,我们就来探讨一下有助于我们获取更佳编程风格的一些最好的规则。

  代码的可读性至上

  代码要能可阅读和可理解,就需要格式化成一致的方式。对函数和变量的命名应有意义,注释的表达应该简洁而准确。并且,准确地记录代码中所有棘手的部分是十分重要的。你必须清楚软件程序为什么能工作以及为什么能在所有可能的情况下顺利工作的原因。

  遵循正确的命名约定是必须的

  当需要给类、函数和变量命名时,你需要遵循以下指南:

  确保特定类名的第一个字母大写;

  使用大小写分离多个单词的命名;

  大写常数名,并使用下划线分离单词;

  确保特定功能和变量名的第一个字母小写;

  注意正确使用缩写。例如,用 max 而不用 maximum。

  必要时可使用空格

  虽然空格对编译器是没有意义的,但是可用于提高代码的可读性。举个例子,你可以在函数间留三个空行。你还可以在函数内使用单独的空行用于分离关键的代码段。

  确保代码有一定的可维护性

  我们需要确保写出来的代码,换成另一个程序员来调整功能、修复bug,也是明确易懂的。要将函数中关键值用常量来标记,这样我们就可以随时根据需要来改变这些常量值。总而言之,代码必须坚固,能够处理任何类型的输入,然后在不崩溃的前提下,提供预期结果。

  注释必须易于理解

  注释应该是有意义的,能够清晰地解释所有关于软件程序的内容。注释的数量多少无所谓,质量才是关键。你需要使用/ *注释* /的风格来写注释,以确保位于每个源文件的顶部。此外,你也可以选择在注释中包括你的名字,编写代码的日期,以及简明扼要地说明程序的实际用途。不过,你可以选择省略一些功能明显的注释。你需要遵循的行内注释格式为//注释。

  正确使用函数

  每一个函数所包含的代码片段,必须既短又能够完成特定的任务。不妨将函数当作是“黑盒子”——独立,编程须知错误,又可以有效处理任何类型的输入。不要忘记这样一条经验规则——即所谓的“Ten Line Rule”,也就是说,一个函数,通常说来,如果超过 10 行,那就需要以最精炼的方式去简化。并且,任何重复性的代码片段都应该被设置为一个单独的函数。上述做法不但可缩短程序的长度,还能大大提高其可读性。

  整齐的代码缩进

缩进在软件程序的流程控制上起着至关重要的作用。每一个新的 while、for、if 语句,以及 switch 结构,都需要缩进代码。这也可用于一行语句中括号已被省去的情况。例如,假设有 if 语句,那么相应 else 语句必须一齐缩进。

时间: 2024-11-05 11:29:11

编程人员应该注意的代码风格的相关文章

Linux内核编程规范与代码风格

source: https://www.kernel.org/doc/html/latest/process/coding-style.html translated by trav, [email protected] 这是一篇阐述Linux内核编程代码风格的文档,译者以学习为目的进行翻译. 1 缩进 Tab的宽度是八个字符,因此缩进的宽度也是八个字符.有些异教徒想让缩进变成四个字符,甚至是两个字符的宽度,这些人和那些把 PI 定义为 3 的人是一个路子的. 注意:缩进的全部意义在于清晰地定义

python代码风格指南:pep8 中文翻译

摘要 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见?PEP7.本文和?PEP 257 文档字符串标准改编自Guido最初的<Python Style Guide>, 并增加了Barry的?GNU Mailman Coding Style Guide的部分内容.本文会随着语言改变等而改变.许多项目都有自己的编码风格指南,冲突时自己的指南为准. 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见PEP7. 本文和PEP 257 文档字符串标准改

7、Cocos2dx 3.0游戏开发找小三之3.0版本号的代码风格

重开发人员的劳动成果,转载的时候请务必注明出处:http://blog.csdn.net/haomengzhu/article/details/27691337 Cocos2d-x代码风格 前面我们已经多次提到 Cocos2d-x 源自于 Cocos2d-iPhone.Cocos2d-iPhone 是一个十分出色的游戏引擎,很多优秀的 iOS平面游戏都基于 Cocos2d-iPhone 开发,而它的实现语言是 Objective-C.因此,Cocos2d-x 也就沿袭了 Objective-C

在Windows下进行的编程人员,你真的需要学习下Linux

从业几年,发现好多编程人员,严重依赖UI工具.对一些命令操作,十分的反感.尤其是从事Windows系统中的程序开发的人员.由于微软对开发工具,编程套件的极限优化.开发出更多的 面向UI的开发工具.从VB6.0 到VC6.0的经典MFC编程.越来越多的Windows开发人员,包括后来的从业者,越发的不能理解那种古老的在命令行下进行代码编程的方式和思维. 从.Net诞生后,微软开发的新一代IDE工具,Visual Studio,越来越华丽,功能越来越强大.所有的操作都是面向UI.不需要进行命令的控制

转:金庸笔下的良好代码风格

我零九年看过一本小说,讲程序员的故事,从此,了解了一个新物种.最近又看<红楼梦>,史湘云有条谜语:"溪壑分离,红尘游戏,真何趣?名利犹虚,后事终难继."我一想,这不就是程序猿吗? 我学过半年编程,唯一的收获是记住了一个名字叫谭浩强.读了那本小说,我知道还有个东西叫"良好的代码风格",这几个字可比谭浩强有意思多了.可以跨领域应用,比方说,用在写作上. 例如,变量的命名.像本文,如果叫<论良好的代码风格>,姿态就不佳,一个"论"

浅谈Kotlin(二):基本类型、基本语法、代码风格

浅谈Kotlin(一):简介及Android Studio中配置 通过上面的文章,在Android Studio中我们已经可以进行Kotlin编程了,接下来开始学习Kotlin的基本类型及语法. 一.基本类型 在 Kotlin 中,所有变量的成员方法和属性都是一个对象. 一些类型是内建的,它们的实现是优化过的,但对用户来说它们就像普通的类一样.   注意,第一个字母大写,Kotlin 区分大小写 主要是以下几种字面值常量: --数型: 123 --长整型要加大写 L : 123L --16进制:

Python代码风格建议(转)

python 以其结构严格著称,同时也以其命名规范散漫出名,算乱无规矩的命名尤其给开发人员带来理解上的误区. 尤其像python.ruby动态语言,由于在运行期随时可能出现方法或者属性的增减,规则的命名尤其重要. ruby语言本身定义的语法规则较为随意,但却不乏一一对应的隐含规则,使人一目了然.其命名规则甚至渗透进了语言本身的规范当中 在命名规则这一点上python显得没规没距.需要逐步养成一个好的编码命名规范. 本文从各大站点文章中搜集了一些代码风格,命名规范.便于学习参考. 代码风格: 使用

[转] Linux内核代码风格 CodingStyle [CH]

from:http://blog.csdn.net/jiang_dlut/article/details/8163731 中文版维护者: 张乐 Zhang Le <[email protected]> 中文版翻译者: 张乐 Zhang Le <[email protected]> 中文版校译者: 王聪 Wang Cong <[email protected]>                wheelz <[email protected]>        

Linux内核代码风格

这是一个简短的文档,描述了linux内核的首选代码风格.代码风格是因人而异的,而且我 不愿意把我的观点强加给任何人,不过这里所讲述的是我必须要维护的代码所遵守的风格, 并且我也希望绝大多数其他代码也能遵守这个风格.请在写代码时至少考虑一下本文所述的 风格. 首先,我建议你打印一份GNU代码规范,然后不要读它.烧了它,这是一个具有重大象征性 意义的动作. 不管怎样,现在我们开始: 第一章:缩进 制表符是8个字符,所以缩进也是8个字符.有些异端运动试图将缩进变为4(乃至2)个字符 深,这几乎相当于尝