排排排排排排排排排排版.md

排排排排排排排排排排版

注意：此篇章為前幾篇各種資料的綜合運用

閱讀過後或了解了再來閱讀此篇內容

一、為什麼要排版？

排版對程式程式師是個最基本的技能

為了讓別人能夠更容易看懂你的 Code 的架構以及內容，或是讓下一個幫你 Debug 的人不會想要殺人

在寫 Code 的時候一定要謹記以下最基礎的排版技巧

範例：

無排版的 Code

  int n = 0;
void setup(){
 Serial.begin(9600);
}

void loop() {
while(n < 200) {
if(n == 10) {Serial.println("n == 10");
}
if(n == 20){
        Serial.println("n == 20");}
     if(n == 30) {
      Serial.println("n == 30");
}
    else Serial.println("以上皆非");n+=5;};
}

//此為簡報中 第116頁 的答案

有排版的 Code

int n = 0;

void setup() {
    Serial.begin(9600);
}

void loop() {
    while(n < 200) {
        if(n == 10) {
            Serial.println("n == 10");
        }

        else if(n == 20) {
            Serial.println("n == 20");
        } 

        else if(n == 30) {
            Serial.println("n == 30");
        }

        else {
            Serial.println("以上皆非");
        }

        n += 5;
    }
}

//此為簡報中 第116頁 的答案

兩個 Code 中

雖然執行出來的邏輯是一模一樣的

但明顯經過排版後的 Code 相較沒排版的較好理解的多

所以說 請排版 請排版 請排版 因為很重要所以說三次

二、如何排版？

一般來說，程式的排版很看程式設計師當下的心情

排版的方式百百種，只看當下想要用哪種

雖說排版的方式很多種，但還是有一些基礎的排版規則

空格：

適當的在你的 Code 當中添加空格，避免擁擠 ex.

擁擠的寫法 ❌

int i=0,b=20;
for(i=0;i<b;i++) //......

適當進行空格做分隔 ⭕

int i = 0, b = 20;

for(i = 0 ; i < b ; i++) //......

對於熟悉 Coding 的人來說，空格的部分可以加的再少一點

但是第二個對於初學者能夠讓他的眼睛能夠有更好的體驗

因此盡可能在適當的地方加入空格以便閱讀

Q. 適當加入空格的地方在哪？

A. 在物件與物件的分隔中加入。

說明：

以第一行的 變數賦值 舉例
int a = 0, b = 0;

[資料型態] [變數名稱] [運算子] [數值], [變數名稱] [運算子] [數值];

在所有的物件當中加入空格做分行 即此意義



除特定情況下，如：段落太長、物件太多等

如果在同個物件中加入 空格or分行 的話 可能也會影響 Code 整體的閱讀體驗

ex.
for   (i = 0 ; i < b ; i++ )

括弧物件應屬for迴圈參數
則括弧與for迴圈不應該有空格

二、縮排

縮排也就是，程式在此行應存在的位置

以上面的 Code 當作範例

在一開始某些行的一開始不會有任何空格

但在下面的行數有些則會加入一些空格

而決定此行縮排大小的因素則是大括弧({})

大括弧內的縮排會比大括弧外的縮排還要再更長

以現今兩種主流的縮排當範例

void foo() {
    if(something) {
        if(another_thing) {
            //do something...
        } else {
            //do something...
        }
    }
    else {
        //do something...
    }
}

void bar() 
{
    if(something)
    {
        if(another_thing)
        {
            //do something...
        }
        else
        {
            //do something...
        }
    }
    else
    {
        //do something...
    }
}

在大括弧以內的內容會比外面的縮排還要再更長即此意思

此方法能夠使大括弧內的執行區塊更容易與其他段落分開閱讀

縮排的長度目前主流為 2 or 4 個半形空格(上面的範例使用的皆為 4格)

為了縮排方便 在大多數 IDE 上面輸入 Tab 也可快速縮排

三、延伸閱讀

縮排風格- 維基百科，自由的百科全書

Day25【ES6 小筆記】有點規矩！讓你的程式碼整整齊齊～

四、本文重點節錄

排版給我排好 臭87