Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 3.29 KB

Markdown写作规范.md

File metadata and controls

75 lines (52 loc) · 3.29 KB

一、标点符号使用约定

  1. 全书正文部分统一使用全角中文标点符号,无论标点前后为中文、数字、英文或其它标点符号。
  2. 英文和数字应该和其前后的中文保留一个空格,例如:

我喜欢使用 Swift 进行编程。

快捷键 0 到 9 分别对应到 inspector 的某个功能。

  1. 英文和全角标点符号之间,数字和全角标点符号之间以及两个全角符号之间,不使用空格,例如:

我喜欢阅读《XR 新手入门》。

通常,我们可以把透明度设置成 0.6。

最后,我们把这个 modifier 添加到 Button 的后面(Button 的右括号的后面)。

  1. 正文中的代码和快捷键,都应使用 code 处理。按代码管理内容。代码的前后,应和正文保留一个空格。例如:

我们可以使用快捷键 shift + cmd + 4 快速截图。

Alert 最简单的构造函数只会生成一个带有默认按钮 OK 的对话框。

二、版式约定

  1. 不要在一段文字描述中,过于频繁的出现类似:我们... 这样的句型结构。
  2. 展示代码的部分,原则上,代码不超过半页。
  3. 正文原则上一个段落不超过 12 行。
  4. 段落之间,保留一个空行。

所谓一般事件,就是指事件序列中,除了正常完成的或者错误事件之外的其它事件。因此,我们可以在控制台看到 Received: Hello, Combine! 这样的结果。但是,却无法观察到 just 完成的事件。这也很正常,因为 sink 的 closure 参数的类型是唯一的,在我们的例子中,就是 String

为了观察到 just 的所有事件,我们得使用另外一个版本的 sink,像这样:

  1. 超过半页长度的代码,应考虑对其内容进行裁剪。把正文和对应的代码进行切分,切分开的部分,代码中用注释表示前后的上下文。
func someFunc() {
  // ... 和以上相同
  // 当前要展示的代码
  // ... 后面完成的工作可以用注释描述
}
  1. 代码和正文之间,保留一个空行。
  2. 代码中应适当加入和正文呼应的注释帮助读者理解。
  3. 所有插图,当图片内容无法撑满正文一整行的时候,统一使用宽度不低于 1280px 的白色背景,避免文档导出时图片过度拉伸:

image

这主要是为了防止一些宽度不够的图片,在一些 ScaleToFit 的场景会出来一张纵向巨长的图片。

目前的 PR 检查中,会在提交后检查使用的图片是否符合要求。

  1. 使用 /quote 表达正文中以下 4 种需要额外提及的内容:

提示:

技巧:

注意:

挑战:

三、内容结构约定

每一章内容,原则上采用以下方式组织内容:

  1. 成果展示(我们要做什么)
  2. 内容讲解(我们怎么做)
  3. 额外挑战(还能做什么)
  4. 要点总结(要记住什么)

另外其他的一些注意点:

  • 内容讲解的部分,要分成适当多个明确的 milestone,到每一个 milestone 的完成时间,不超过 30 分钟。
  • 要点总结部分,要精简干练,描述成可以遵循的原则,需要避免的问题,值得记住的技巧等。避免冗长的总结性描述。