約定

導航專案頁面主題: ( v • d • e ) 最近更改如果您有與 Java 相關的疑問如果您有興趣編輯此書如何格式化內容誰在貢獻流量

這些約定旨在提高 Java 程式設計華夏公益教科書的可讀性和理解度。它補充了華夏公益教科書風格指南。但是，如果需要，可以做出例外。如果您覺得遵循它太複雜，請直接新增內容。它將由其他人進行格式化。

頁面格式

大多數情況下，Java 程式設計華夏公益教科書中的頁面結構如下所示

您編寫

您獲得

<noinclude>{{Displaytitle|title=The title of the page}}
{{Nav}}
{{Java Programming/LanguageFundamentalsTopic/Nav}}
__NOTOC__</noinclude>

This is the introduction.

==First section==

This is a section.

<noinclude>
{{Nav}}
{{Status|50%}}</noinclude>

導航語言基礎主題: ( v • d • e ) 語句條件塊迴圈塊布林表示式變數基本型別算術表示式字面量方法字串物件包陣列數學函式大數隨機數 Unicode 註釋關鍵字編碼規範 Lambda表示式

這是引言。

第一節

這是一節。

示例

Java檔案

有時我們希望傳達整個Java檔案，可以按以下方式進行。

您編寫您獲得

{{XCode|1='''Code listing 1.1: The <code>MyClass</code> class'''
<syntaxhighlight lang="java">
class MyClass{}
</syntaxhighlight>}}

程式碼清單1.1：MyClass類

class MyClass{}

“1.1”表示它是第一章的第一段程式碼。使用<syntaxhighlight/>比使用模板更好，因為||是Java語法的組成部分。

程式碼片段

當只顯示一小部分程式碼時，可以使用以下程式碼模板。

您編寫您獲得

{{XExample|1='''Code section 1.1: The <code>MyClass</code> class'''
<syntaxhighlight lang="java">
for (int i=0; i<10; i++) {
    System.out.println("Hello!");
}
</syntaxhighlight>}}

程式碼段1.1：MyClass類

for (int i=0; i<10; i++) {
    System.out.println("Hello!");
}

螢幕截圖

要表示螢幕上顯示的內容，請使用以下語法。

您編寫

您獲得

{{XConsole|1='''Output for the application'''
<pre style="background-color:#000; color:#fff;">
Hello World!
</pre>}}

應用程式的輸出

Hello World!

備註

備註為讀者提供了有關特定主題的額外資訊。您可以使用以下模板輸入附加或旁註。

您編寫

您獲得

{{XNote|This is an additional note.}}

這是一個附加備註。

只有在必要時才使用備註。備註比段落的可讀性差。

警告

要提醒使用者注意常見陷阱等問題，應使用XWarning模板，如示例所示。

您編寫

您獲得

{{XWarning|This is a warning.}}

這是一個警告。

待辦事項

如果書中某些部分需要日後關注，您可以透過包含以下模板新增待辦事項備註。

您編寫

您獲得

{{TODO|To-do items for pages should be kept in their respective comment boxes.|Java Programming}}

待辦
頁面的待辦事項應儲存在各自的註釋框中。

隱藏部分

如果某個部分是可選的，可以像這樣隱藏它。

您編寫	您獲得
{{Java/Hidden begin\|title=Hidden section}} This section is not mandatory. {{Hidden end}}	隱藏部分本節不是強制性的。

插圖和圖表

本書使用各種插圖和圖表來傳達其資訊，例如流程圖或UML圖等。由於圖表的性質，需要以可縮放的向量格式進行設計。強烈建議您為圖表使用SVG格式。請不要對可以用SVG製作的圖表使用JPG或PNG。請向常規貢獻者尋求幫助。

本書中使用的圖表的一個常用功能是整體配色方案。本書插圖中使用最顯眼的顏色是 #2a7fff（例如，如以下圖表所示）。為了將插圖包含到您的內容中，您需要使用{{Java/Illustration}}模板。下面是如何使用該模板的示例。

您編寫

您獲得

{{Java/Illustration
|number=1
|caption=A sample illustration from the book
|image=[[File:Java Compilation Basics.svg|center]]
}}

圖1：本書中的示例插圖

文字格式

首次使用術語時使用斜體。
當您引用類、欄位或方法時，請使用<code/>標記。

首選英語

本書使用美國英語，純粹是為了保持一致性。大多數程式語言使用美國英語表示的詞語，例如color等。您應儘可能使用美式英語。

程式碼規範

本書遵循官方Java程式碼規範。下面是一個示例。

程式碼段0.1：官方Java程式碼規範

if (foo == bar) {
    // do stuff
} else {
    // do other stuff
}