现在的位置:首页 > 软件开发行业资讯 > 新闻详情

可读性 (Readability)

diff的大小

bug修改,无所谓,该多大多大。一般bug fix不会超过100行。超过的要特别重视,想想究竟是什么原因造成。会不会是当初设计的问题。

一个diff,原则上不应该超过200-300行修改。但多了怎么办,把一个diff变成多个 – split to multiple changes.

每个diff应该只做一件事情

每个diff尽可少的做一个改动。这样可以尽可能的方便自己的管理(学会用git branch),和方便reviewer的代码审查。如果diff越集中做一件事,审查代码的人需要越短的时间来审查做出高质量的,整体效率越高。

一个function超过1屏 => split it, idiot.

统一的代码规范

比如文件名,变量或函数名的命名规范,分行的前置空2个spaces或4个;每行的字数(不应超过80char);如何使用public/private/protected;用左右括号的原则;空行的使用;文件和代码comments的位置 (比如,代码comment只能单独成行);对“// TODO:”的使用规范;macro,constant的使用;

等等等等。

这里没有特别的哪一种style一定更对,但是需要有一个大家统一的guideline,一起遵守,让整体的代码有统一的风格和标准。

最大的好处就是有利于readability.

object-oriented v.s function-oriented

Java本身就是面向对象,所以这个问题不大。但千万不要出现披着面向对象的外皮,在class里面写超长的面向函数的处理。这种情况下,尽可能的分流成helper function.

crispy & sufficient的注释

注释应当简洁但充分。有些人觉得代码应该speak for itself。我不大同意,代码是实现细节,适当的在意图上给予说明,可以大幅度的减少读代码的人的烦恼。


----淄博软件开发----

想要了解更多详情欢迎来电咨询18678812288,或登陆网址www.wfydkj.net 联系人:王经理。

软件开发行业资讯

公司新闻

软件开发成功案例 查看更多+

  • 淄博智慧井盖---潍坊智慧井盖智能

    淄博智慧井盖---潍坊智慧井盖智能

  • 潍坊环卫人员管控平台--淄博在外

    潍坊环卫人员管控平台--淄博在外

  • 淄博、潍坊检察院人员分类管理绩

    淄博、潍坊检察院人员分类管理绩

  • 潍坊应急管理局智慧化平台整体解

    潍坊应急管理局智慧化平台整体解

  • 淄博交规速成系统|潍坊交规考试软

    淄博交规速成系统|潍坊交规考试软

  • 检察院网络服务大厅软件平台

    检察院网络服务大厅软件平台

  • 企业在线考试系统

    企业在线考试系统

  • 党员在线考试系统

    党员在线考试系统

  • 淄博心理测评软件|潍坊心理测评系

    淄博心理测评软件|潍坊心理测评系

  • 潍坊内部培训管理系统|淄博出国留

    潍坊内部培训管理系统|淄博出国留

  • 潍坊物流软件开发|淄博快递软件开

    潍坊物流软件开发|淄博快递软件开

  • 狠刹“四风”网络监督平台软件

    狠刹“四风”网络监督平台软件

  • 党员领导干部德廉知识在线学习测

    党员领导干部德廉知识在线学习测

  • 潍坊在线考试系统|淄博在线考试软

    潍坊在线考试系统|淄博在线考试软

  • 菏泽新巨龙煤矿采掘资料达标管理

    菏泽新巨龙煤矿采掘资料达标管理

  • 科技信息评价信息系统

    科技信息评价信息系统

  • 绩效考核系统

    绩效考核系统

  • 济钢炼铁厂管理信息系统

    济钢炼铁厂管理信息系统

  • 国税房产企业所得税监控管理系统

    国税房产企业所得税监控管理系统

  • 人力资源管理信息系统

    人力资源管理信息系统

无标题文档