D 語言入門指南/風格指南

D 語言入門指南

大膽嘗試

不要害怕做出改變。如果某些內容表達不佳，請直接修改。如果只需要進行微調，請直接修正。不要讓任何低於此內容的東西阻止你。

但是，如果你想要撰寫或編輯完整的頁面，請繼續閱讀。

組織

本書分為章節和子章節。章節通常指的是一般主題，其子章節則指的是具體主題。章節編號，但編號約定僅用於目錄：不應假設這些數字是靜態的。

每個章節都有自己的頁面（子章節沒有），每個章節都有一個頁面，它僅僅是對概念的介紹，以及該章節的目錄。請注意，這意味著目錄需要在兩個位置維護（首頁和每個章節）。

命名

目錄中的章節名稱應該以其將要教授的概念命名，而不是構造。也就是說，例如，一個章節不應該被命名為“if 條件語句”，而應該被命名為“條件和分支”。在實現一個章節時，請為它起一個概念性的名稱；如果它不是概念性的，不要保留目錄中的名稱。標題應首字母大寫，但標題中的 D 關鍵字不應首字母大寫。

開發

在撰寫頁面時，使用模板來顯示它是一個存根。如果你仍然在積極地撰寫它，請使用此模板

否則，請使用章節存根

或子章節存根

{{sectstub}}

根據需要。

依賴

任何章節都不應該依賴於後面章節中教授的概念。這應該非常明顯。

完全可以引用未來的概念，只要你實際上並不依賴於它們的學習。

風格

新的術語應該用斜體表示，變數名稱用'單引號'表示，程式碼片段、關鍵字或符號用等寬字型表示。避免使用第一人稱（即“我”、“我”、“我的”等）和第二人稱（即“你”、“你的”等）。

隨意使用比喻來描述概念，只是要注意不要將它們超出其界限。

程式碼

大多數章節應該包含一個或多個示例程式碼部分，無論它們多麼瑣碎。
本書是關於D語言，而不是Phobos，所以請在示例中只使用din和dout。Phobos和其他流行庫的描述將包含在附錄中。
儘量使每個示例，在適當的情況下，成為一個完整的應用程式，以便它包含一個main()函式，並且可以在一步內編譯和執行。
本書中的程式碼部分必須使用以下編碼約定

int fun(int a, bool b, float c) // spaces between function parameters
{
    // opening brace goes on its own line
    if (before) // conditionals, loops, etc... have a space before their arguments
    {
        // this brace style in functions, conditionals, and declarations
    }
    else
    {
        class Foo : Bar
        {
        }
    }
    
    // four spaces (no tabs) for indentation and alignment

    // empty lines may or may not have spaces

    int sample = 2 + 3; // space between operators and their operands
                        // no space before final ';'
    sample++;   // Except that there is no space between unary operator
                // and its operand.
    --sample;
     
    xyzzy(sample, 3.1472); // no space between function call and param list
    
    while (a.very.long.line.is.being.forced && to.wrap || or.look.very.ugly +
           it.will.wrap.at.column - 80)
    {
    }
}
void main()
{
    fun(42, true, 99.94);
}

控制檯輸入/輸出

示例控制檯輸出應該以粗體、等寬的塊顯示。換行應該像程式碼示例一樣在第 80 列處進行。示例輸入應該以粗體斜體顯示。例如

This is an example of console output. It wraps at column 80. Lorem ipsum dolor 
sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut 
labore et dolore magna aliqua.

Enter user name: example
Enter password: ****

複雜度

請記住，這是一本 D 語言入門指南。所以

不要糾結於規則的奇怪例外。如果必須提到它們，就提到它們，但不要讓讀者感到困惑，因為他們可能對程式設計一無所知。
如果你發現自己需要參考後面的章節來解釋當前章節，那麼目錄就需要改變——每個章節都應該只依賴於它之前的章節。

過渡使用者

（本節中提出的規則尚未正式接受）

為了使本書可供經驗豐富的程式設計師使用，提供了一些模板來顯示某些內容對於某些使用者來說是冗餘的。這些模板是

{{A Beginner's Guide to D/Skim X}}

熟悉C++的程式設計師可能會發現本節內容很熟悉，並且可能想略讀或跳過它，具體由他們自己決定。

{{A Beginner's Guide to D/Skim J}}

熟悉Java的程式設計師可能會發現本節內容很熟悉，並且可能想略讀或跳過它，具體由他們自己決定。

{{A Beginner's Guide to D/Skim CX}}

熟悉C 或 C++的程式設計師可能會發現本節內容很熟悉，並且可能想略讀或跳過它，具體由他們自己決定。

{{A Beginner's Guide to D/Skim XJ}}

熟悉C++ 或 Java的程式設計師可能會發現本節內容很熟悉，並且可能想略讀或跳過它，具體由他們自己決定。

{{A Beginner's Guide to D/Skim CXJ}}

熟悉C、C++ 或 Java 的程式設計師可能會發現這部分內容很熟悉，並可能根據自己的判斷選擇略讀或跳過。

這些模板應該位於節的頂部，緊接在署名之後，或者如果節的其餘部分不適用，則位於小節的頂部。