代码风格
代码风格
Leung_ManWah
这个作者很懒,什么都没留下…
展开
-
代码风格(5)——类
一、类应该短小类和函数一样应该短小。对于函数,我们通过计算代码行数衡量大小。对于类,我们采用不同的衡量方法,计算 权责。类的名称应当描述其权责。实际上,命名正是帮助判断类的长度的第一个手段。如果无法为某个类命以精确的名称,这个类大概就太长了。类名越含混,该类越有可能拥有过多权责。例如,如果类名中包括含义模糊的词,如 Processor 或 Manager 或 Super,这种现象往往说明有不恰...原创 2019-11-03 17:51:37 · 636 阅读 · 0 评论 -
代码风格(4)——格式
一、总述每个人都可能有自己的代码风格和格式,但如果一个项目中的所有人都遵循同一风格的话,这个项目就能更顺利地进行。每个人未必能同意下述的每一处格式规则,而且其中的不少规则需要一定时间的适应,但整个项目服从统一的编程风格是很重要的,只有这样才能让所有人轻松地阅读和理解代码。二、行2.1 行长度每一行代码字符数不超过 120注释行可以超过 120 个字符,但最大不超过 1502.2 行宽度...原创 2019-10-30 22:39:10 · 1167 阅读 · 0 评论 -
代码风格(3)——注释
一、总述注释虽然写起来很痛苦,但对保证代码可读性至关重要。当然也要记住:注释固然很重要, 但最好的代码应当本身就是文档。有意义的类型名和变量名,要远胜过要用注释解释的含糊不清的名字。1.1 注释风格使用 // 或 /* */ 都可以;但 //更常用二、文件注释在每一个文件开头加入版权公告/**==============================================...原创 2019-10-28 23:15:46 · 1318 阅读 · 0 评论 -
代码风格(2)——函数
一、简短函数1.1 总述函数的第一规则是要简短,凝练。1.2 说明长函数有时是合理的,因此并不硬性限制函数的长度。但如果函数超过40行,可以思索一下能不能在不影响程序结构的前提下对其进行分割。函数20行封顶最佳,每行字符数不应超过120个。即使一个长函数现在工作的非常好,一旦有人对其修改,有可能出现新的问题,甚至导致难以发现的Bug。使函数尽量简短,以便于他人阅读和修改代码。...原创 2019-04-30 10:03:33 · 702 阅读 · 0 评论 -
代码风格(1)——命名约定
一、命名约定最重要的一致性规则是命名管理。命名的风格能让我们在不需要去查找类型声明的条件下快速地了解某个名字代表的含义:类型,变量,函数,常量,宏等等,甚至我们大脑中的模式匹配引擎非常依赖这些命名规则。命名规则具有一定随意性,但相比按个人喜好命名,一致性更重要,所以无论你认为它们是否重要,规则总归是规则。二、通用命名规则2.1 总述函数命名,变量命名,文件命名要有描述性;少用缩写。...原创 2019-04-18 11:55:17 · 1824 阅读 · 2 评论