写出漂亮代码的七种方法

首先我想说明我本文阐述的是纯粹从美学的角度来写出代码,而非技术、逻辑等。以下为写出漂亮代码的七种方法:

1. 尽快结束 if语句 例如下面这个JavaScript语句,看起来就很恐怖:

1 function findShape(flags, point, attribute, list) {

2 if(!findShapePoints(flags, point, attribute)) {

3 if(!doFindShapePoints(flags, point, attribute)) {

4 if(!findInShape(flags, point, attribute)) {

5 if(!findFromGuide(flags,point) {

6 if(list.count() > 0 && flags == 1) {

7 doSomething();

8 }

9 }

10 }

11 }

12 }

13 }

但如果这么写就好看得多:

1 function findShape(flags, point, attribute, list) {

2 if(findShapePoints(flags, point, attribute)) {

3 return;

4 }

5

6 if(doFindShapePoints(flags, point, attribute)) {

7 return;

8 }

9

10 if(findInShape(flags, point, attribute)) {

11 return;

12 }

13

14 if(findFromGuide(flags,point) {

15 return;

16 }

17

18 if (!(list.count() > 0 && flags == 1)) {

19 return;

20 }

21

22 doSomething();

23

24 }

你可能会很不喜欢第二种的表述方式,但反映出了迅速返回if值的思想,也可以理解为:避免不必要的else陈述。

2. 如果只是简单的布尔运算(逻辑运算),不要使用if语句

1 function isStringEmpty(str){

2 if(str === "") {

3 return true;

4 }

5 else {

6 return false;

7 }

8 }

可以写为:

1 function isStringEmpty(str){

2 return (str === "");

3 }

3. 使用空白,这是免费的

例如:

1 function getSomeAngle() {

2 // Some code here then

3 radAngle1 = Math.atan(slope(center, point1));

4 radAngle2 = Math.atan(slope(center, point2));

5 firstAngle = getStartAngle(radAngle1, point1, center);

6 secondAngle = getStartAngle(radAngle2, point2, center);

7 radAngle1 = degreesToRadians(firstAngle);

8 radAngle2 = degreesToRadians(secondAngle);

9 baseRadius = distance(point, center);

10 radius = baseRadius + (lines * y);

11 p1["x"] = roundValue(radius * Math.cos(radAngle1) + center["x"]);

12 p1["y"] = roundValue(radius * Math.sin(radAngle1) + center["y"]);

13 pt2["x"] = roundValue(radius * Math.cos(radAngle2) + center["y"]);

14 pt2["y"] = roundValue(radius * Math.sin(radAngle2) + center["y");

15 // Now some more code

16 }

很多开发者不愿意使用空白,就好像这要收费一样。我在此并非刻意地添加空白,粗鲁地打断代码的连贯性。在实际编写代码的过程中,会很容易地发现在什么地方加入空白,这不但美观而且让读者易懂,如下:

1 function getSomeAngle() {

2 // Some code here then

3 radAngle1 = Math.atan(slope(center, point1));

4 radAngle2 = Math.atan(slope(center, point2));

5

6 firstAngle = getStartAngle(radAngle1, point1, center);

7 secondAngle = getStartAngle(radAngle2, point2, center);

8

9 radAngle1 = degreesToRadians(firstAngle);

10 radAngle2 = degreesToRadians(secondAngle);

11

12 baseRadius = distance(point, center);

13 radius = baseRadius + (lines * y);

14

15 p1["x"] = roundValue(radius * Math.cos(radAngle1) + center["x"]);

16 p1["y"] = roundValue(radius * Math.sin(radAngle1) + center["y"]);

17

18 pt2["x"] = roundValue(radius * Math.cos(radAngle2) + center["y"]);

19 pt2["y"] = roundValue(radius * Math.sin(radAngle2) + center["y");

20 // Now some more code

21 }

4. 不要使用无谓的注释

无谓的注释让人费神,这实在很讨厌。不要标出很明显的注释。在以下的例子中,每个人都知道代码表达的是“students id”,因而没必要标出。

1 function existsStudent(id, list) {

2 for(i = 0; i < list.length; i++) {

3 student = list[i];

4

5 // Get the student's id

6 thisId = student.getId();

7

8 if(thisId === id) {

9 return true;

10 }

11 }

12 return false;

13 }

5. 不要在源文件中留下已经删除的代码,哪怕你标注了 如果你使用了版本控制,那么你就可以轻松地找回前一个版本的代码。如果别人大费周折地读了你的代码,却发现是要删除的代码,这实在太恨人了。

//function thisReallyHandyFunction() {

// someMagic();

// someMoreMagic();

// magicNumber = evenMoreMagic();

// return magicNumber;

//}

6.不要有太长的代码 看太长的代码实在太费劲,尤其是代码本身的功能又很小。如下:

1 public static EnumMap<Category, IntPair> getGroupCategoryDistribution(EnumMap<Category, Integer> sizes, int groups) {

2 EnumMap<Category, IntPair> categoryGroupCounts = new EnumMap<Category,IntPair>(Category.class);

3

4 for(Category cat : Category.values()) {

5 categoryGroupCounts.put(cat, getCategoryDistribution(sizes.get(cat), groups));

6 }

我并不是说非要坚持70个字符以内,但是一个比较理想的长度是控制在120个字符内。如果你把代码发布在互联网上,用户读起来就很困难。 7.不要在一个功能(或者函数内)有太多代码行 我的一个老同事曾经说Visual C++很臭,因为它不允许你在一个函数内拥有超过10,000行代码。我记不清代码行数的上限,不知道他说的是否正确,但我很不赞成他的观点。如果一个函数超过了50行,看起来有多费劲你知道么,还有没完没了的if循环,而且你还的滚动鼠标前后对照这段代码。对我而言,超过35行的代码理解起来就很困难了。我的建议是超过这个数字就把一个函数代码分割成两个。

(修改自网络)

原文发布于微信公众号 - 程序员互动联盟(coder_online)

原文发表时间:2015-11-26

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏工科狗和生物喵

对菜鸟教程的Python一百例的个别改进

好吧,其实是小妹子Python公选课结课,所以我来帮忙做个大作业(简单到哭的大作业好吗?)!她的大作业就是老师把菜鸟教程的Python一百例扒下来做成文档,然后...

43060
来自专栏数说工作室

正则表达式的“阿赖耶识”| 【SAS Says·扩展篇】正则表达式

阿赖耶识...为宇宙万有之本,含藏万有,使之存而不失,故称藏识。又因其能含藏生长万有之种子,故亦称种子识。 ——《佛光大辞典》 佛家说人有九识,除眼、耳、鼻、舌...

34930
来自专栏十月梦想

vue列表渲染(数组和对象)

我们知道这个vue是mvvm模型,数据改变,视图层就改变但是通过实例改变app.list[3]="新设置",发现数据改变了视图层无法改变,那么如何保持数据和视图...

46410
来自专栏互扯程序

Java8函数式编程实践精华

现在是资源共享的时代,同样也是知识分享的时代,如果你觉得本文能学到知识,请把知识与别人分享。

13630
来自专栏互联网杂技

基础JavaScript装逼指南

本文秉承着 你看不懂是你sb,我写的代码就要牛逼 的理念来介绍一些js的装逼技巧。 下面的技巧,后三个,请谨慎用于团队项目中(主要考虑到可读性的问题),不然,l...

35750
来自专栏令仔很忙

C#----委托和事件(一)

最近在做的项目,正在进行重构,之前的框架就是纯三层的简单调用,外加一些Session,SQLHelper等封装管理类,其他的东西,一直也想去抽象,但是奈何能力...

79010
来自专栏杨建荣的学习笔记

对一道if-else相关的程序题的简单分析(r5笔记第45天)

今天同事在微信群里提出了一个问题,看似是一个面试题。 大体的意思就是补充下面if条件使得输出 Hello World if(){ System.out.prin...

36550
来自专栏程序员的SOD蜜

JavaScript的“原型甘露”

今天跟朋友讨论JS的面向对象编程问题,想起了原来曾经看过一篇文章,但是看过很久想不起来了,用了很多关键词,终于用“悟透JavaScript  面向对象”这两个关...

27480
来自专栏青玉伏案

代码重构(二):类重构规则

在上篇博客《代码重构(一):函数重构规则(Swift版)》中,详细的介绍了函数的重构规则,其中主要包括:Extract Method, Inline Metho...

236100
来自专栏斑斓

使用Option的正确姿势

我们会频繁地使用Scala的Option,用以解决类似Null Object之类的问题。某种程度讲,使用Option必然会减少对空指针引用判断的丑陋代码,结合F...

29550

扫码关注云+社区

领取腾讯云代金券