mirror of
https://github.com/LearnOpenGL-CN/LearnOpenGL-CN.git
synced 2025-08-22 20:25:28 +08:00
Update styleguide
This commit is contained in:
@@ -37,9 +37,15 @@
|
||||
|
||||
- 文本中常量/代码用``加注为代码
|
||||
- 代码块不使用Tab标注,请用```式标注
|
||||
- 代码的语言需要在代码一开始的标记处标识出来,比如```c++
|
||||
- 代码的语言需要在代码一开始的标记处标识出来,比如
|
||||
|
||||
```c++
|
||||
[code]
|
||||
```
|
||||
|
||||
- 请记得翻译注释
|
||||
- 注释与`//`间请加一个空格
|
||||
- 原文的代码看起来像是加粗,如果真的是代码则用代码,如果不是则用加粗(比如原文中的VS的选项及文件夹)
|
||||
|
||||
## 图片
|
||||
|
||||
@@ -70,6 +76,10 @@
|
||||
|
||||
- 所有的引用链接请使用相对链接,地址为从当前文件目录转到引用文件的相对地址(文件名结尾为`.md`)
|
||||
|
||||
## 列表
|
||||
|
||||
- 列表请与其他元素之间空一行,否则解析会出错。
|
||||
|
||||
## 专有名词
|
||||
|
||||
- 专有名词需要在第一次出现的之后用括号标注原文
|
||||
|
Reference in New Issue
Block a user