约定

导航项目页面主题: ( 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
}