如何编写整洁的代码

时间:2013-10-03 11:14:36

标签: javascript php html mysqli

我从来没有被教过如何缩进/布局我的代码。

当代码开始变长时,我常常会对代码布局感到困惑。

缩进代码时是否应遵循一套标准规则?或者只是你必须找到最适合你的方式?

2 个答案:

答案 0 :(得分:4)

最终,代码必须对您而言清晰;但是,如果你与他人合作,你可能会遵循一个标准。通常,每个块应该具有相同的缩进级别。块通常由大括号{ }之间的代码定义。如果其中有另一个块,则应该通过另一个选项卡缩进。 例如:

function foo(bar) {
    var i = 0;
    if(bar == "something") {
        i = 1;
        console.log("message");
        alert("another message");
    } else if(bar == "something else") {
        i = 2;
        console.log("something else");
    } else {
        i = 3;
    }
    return i;
}

功能块内的所有代码都缩进了1个选项卡,以便将其与函数原型区分开来,因此很容易阅读。此外,if块还被缩进以进一步将它们与函数中的其余代码区分开来。这很干净,易于阅读。这是我个人坚持的风格,然而,有些人却略有不同。其他变体不太紧凑。例如,您可能会看到:

function foo(bar) 
{
    var i = 0;
    if(bar == "something") 
    {
        i = 1;
        console.log("message");
        alert("another message");
    } 
    else if(bar == "something else") 
    {
        i = 2;
        console.log("something else");
    } 
    else 
    {
        i = 3;
    }
    return i;
}

这是一种略有不同的方法。有人说它更容易阅读,但我发现我的方法很容易阅读和更紧凑。当您编写包含数千行的大型脚本时,紧凑性非常有用。请注意第一个示例如何有14行,而第二个示例有20行。这意味着更大的项目中滚动更多。

最终,就编译器或解释器而言,除了1个空格之外的任何空格(对于大多数现代语言,这都适用)将被忽略,所以实际上,你可以将这一切都写在一行上。计算机并不关心,但它几乎不可能阅读。

希望这有帮助!

答案 1 :(得分:1)