贡献本项目¶
在贡献之前,请您详细阅读本页面。
贡献方式¶
请使用标准的 Markdown 格式(后缀名为 .md
)编写您的文档,并以附件的形式发送到 19173155158@163.com 邮箱。注意需要标注好作者名以及文档应该存放的位置,好渴鹅收到之后会在七个工作日之内给与回复。这也避免了一部分人不会使用 Git 的缺陷。
格式要求¶
贡献的 Markdown 文档需要遵守以下规定,若不遵守将在回复中给予打回。为了不磨灭自己的信息和灵感,以下内容可能尤其重要。
Markdown¶
- 为了更好地兼容,并使用 UTF-8 编码。
- 一级标题是用来描述整篇文章的标题的,文中的标题请使用二级标题即以上的标题。尽量不要再标题当中使用 Markdown 元素,不然在右侧目录可能会有奇奇怪怪的问题出现。(特别是数学公式)
- 中文、英文与公式之间需要空上一格,但是与标点符号之间不需要空格。如果附带圆括号,那么句号可以打在圆括号前面和圆括号后面,不要打在圆括号里面。
- 行内数学公式请使用
$
扩住,行间数学公式请使用$$
扩住。 - 每一个块级元素之间需要空上一行,这是为了更好地兼容老版本 Markdown。
- 单独一行公式不需要打标点符号,单独一段英文需要打上句点,其余打中文句号。
- 对于小段站外内容,可以直接引用并标注来源;对于大段站外内容,直接使用超链接即可。
- 如果你的文档使用了图片,那么要把图片放进附件里面一起上传。
- 对于需要分点讨论的内容,若是点与点之间是并列关系的话,那么使用无序列表,否则使用有序列表。
- 代码统一使用 Google 风格,缩进两个空格。不要使用制表符,因为制表符的长度不确定。Google 代码风格的具体信息可以看下面的“代码风格”专栏。
- 如果可以使用 Markdown 语法简单表述的话,不要使用 HTML 标签。但是在某些情况下,使用 HTML 标签可以更好地表达内容,比如图片等。
<center>
标签虽然在 HTML 5 当中已经废弃了,但是仍然可以使用并不需要修改。- 代码当中的命名需要基本满足 Java 命名规范。具体可以看“命名规范”专栏。
代码风格¶
使用 Google 代码风格,缩进两个空格。
换行¶
- 对于 main 函数以及自定义函数,花括号要换行。
- 对于
if
、while
、try
等控制语句,花括号不需要换行,并在前面空上一行。 - 如果一行当中的代码过长,那么需要在合适的位置换行并对齐。
花括号¶
- 如果语句只有一行,加不加都符合标准。
- 如果循环没有循环体,那么花括号需要加上(换不换行都可以)。因为如果是
while
循环的话,不加花括号看起来就像是do-while
循环的一部分。 - 其余情况都需要加上花括号。
空格¶
while
、if
等控制语句需要在圆括号前面加上空格,这样就可以与函数区分。- 二元运算符的两端需要空上一格,逗号后面需要空上一格,一元运算符不需要空格。ddd
- 圆括号里面不需要额外空格。
注:不一定需要严格遵守,只要代码阅读起来美观且易读。