Spaces for readability in code

Question

K E 2012-11-8

4
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/53214-spaces-for-readability-in-code

Which of following lines of code do you think is more readable:

plot(rand(1,1,1)+17/2,'r*');%No spaces
plot(rand(1, 1, 1) + 17/2, 'r*') ; % Space after commas, around arithmetic, before semicolons

I code with convention #2, which feels closer to the spacing of written text, but #1 seems to be more standard among Matlab programmers.

EDIT: Too much space is hard to parse, so I am going stop leaving space before commas. Personal preference seems to be the rule. Thanks everyone.

plot(rand(1,1,1) + 17/2, 'r*') ;

2 个评论
显示无隐藏无

John Petersen 2012-11-8

在 MATLAB Online 中打开

I mostly use a combination of that where I condense with commas, but use more spacing for arithmetic, e.g.

plot(rand(1,1,1) + 17/2, 'r*')

Evan 2012-11-8

编辑：Evan 2012-11-8

在 MATLAB Online 中打开

I generally don't put spaces between commas, semicolons, colons and parenthesis. I use spaces for arithmetic (except for exponents, for some reason :P) and logical operators. For some reason I've always found code with no spaces after equals signs, addition, etc. to be messy and hard to read.

So I would type your example like this:

plot(rand(1,1,1) + 17/2,'r*');

EDIT: I would say I prefer your convention #2 over #1.

请先登录，再进行评论。

请先登录，再回答此问题。

Answer 1

Daniel Shub 2012-11-9

1
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/53214-spaces-for-readability-in-code#answer_64860

在 MATLAB Online 中打开

I recently found out that spacing can matter. I generally go with no spaces between operators, but always spaces after commas and surrounding equal signs

plot(rand(1, 1, 1)+17/2, 'r*')
A = (rand(1, 5)-3)+bsxfun(@(x, y)x+y, Z, U)-cellfun('length', M{:})

At one point I thought that it might be cleaner to do

A = minus(plus(minus(rand(1, 5), 3), bsxfun(@(x, y)plus(x, y), Z, U)), cellfun('length', M{:}))

but that was a short lived experiment.

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

请先登录，再进行评论。

Answer 2

Sean de Wolski 2012-11-8

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/53214-spaces-for-readability-in-code#answer_64809

编辑：Sean de Wolski 2012-11-8

在 MATLAB Online 中打开

#

My eyes don't like having to parse an entire monitor. Though I do like spaces and commas in concatenations:

function [x, y, z] = foo(Q)
   x = [Q, Q, Q];
   y = ismember(Q,pi);
   z = 17+5;
end

1 个评论
显示 -1更早的评论隐藏 -1更早的评论

K E 2012-11-9

Good point. #2 is too spread out.

请先登录，再进行评论。

Answer 3

Matt Fig 2012-11-8

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/53214-spaces-for-readability-in-code#answer_64810

编辑：Matt Fig 2012-11-8

在 MATLAB Online 中打开

Here is how I do it:

plot(rand(1,1,1) + 17/2,'r*')
A = (rand(1,5) - 3) + bsxfun(@(x,y) x+y,Z,U) - cellfun('length',M{:})

No spaces around commas, spaces B&A: =+-*/ unless the operands are easily seen by my eye and not between paranthesis or function calls. So for example, the two operands to the plus are not easily picked out, so I put a space B&A. The operands to the division are, so no space. Commas stick out like sore thumbs to me, so I never space them or semicolons.

Yep, I make my own spacing rules and I like them!