格式化代码的正确方法是什么？

Question

当我编写代码时,我尝试将类似代码的行分组在一起,然后留下一个空行并写入另一个块.

我相信这有助于代码的整洁性和可读性.

我不喜欢把东西聚在一起而没有任何行间距.它看起来很糟糕,很难阅读而且难以理解.

我的一位老师,降级了我的一项任务,因为我在逻辑上间隔了我的代码.他说,"当你必须在现实世界中整天阅读代码时,你不会把这个行间距放进去,你会感谢我."当然,我从来没有做过,也永远不会感谢他.

现在,我在现实世界中,我看到的绝对没有行间距的大多数代码文件编写得很糟糕而且考虑不周.

这在VB类型语言中可能比在C类型语言中更为普遍,但同样的概念也适用.

我想到两个问题:

Answer 1

编辑:C#的标准是不要与IDE对抗.如果点击CTRL K+D,IDE将自动在代码段之间放置空行.

为了做到这一点,如果你在MSDN或其他任何地方查看C#示例代码,每个逻辑放置的组之间通常都会有一个空行.因此,所有成员变量后面都会出现一个空行,每个方法后面都有一个空行等.

回应表达震惊和恐怖的评论,我使用IDE进行C#编程:

真正的程序员

Answer 2

我想我做了类似的事情,但没有硬规则.我喜欢在分组/相关逻辑的"段落"中间隔的代码.

没有额外行空格的代码很难阅读.

Answer 3

听起来我的代码行与您类似.

但这是一种无关紧要的个人偏好,每个人都会有自己的"正确方法"去做.最重要的是,恕我直言,是为了适应你正在进入的环境的风格.

此外,你会在"现实世界"中找到这样的代码......但听起来你有更高的抱负.;-)

编辑:...不比"现实世界"更高的愿望,但高于"现实世界"中普遍存在的平庸废话....如果你确实比"现实世界"有更高的愿望,你可能想看到一个专业人士.;-)

Answer 4

我的经验法则是:

在可以用一条注释描述的代码块之间放置一个空行.

但一般来说,我同意许多具有大量空白区域的大型函数应该分解为更小的函数.

Answer 5

由于我们没有关于"逻辑"行间距的个人想法的例子,我们无法确切地说你是否应该被降级.

我倾向于在间隔之前将序列中的类似语句或步骤组合在一起(例如变量声明,循环等)

Answer 6

在我看来，在代码中添加空格暗示您应该将函数拆分为更小的部分。通过添加空格来清理代码比一英里长的不分隔行列表更好。通过分离出较小的函数来清理代码会更好。