1
0
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:
Meow J
2016-07-07 00:15:13 +08:00
parent 7175268616
commit 1faa3ae199

View File

@@ -33,8 +33,6 @@
OpenGL规范严格规定了每个函数该如何执行以及它们的输出值。至于内部具体每个函数是如何实现(Implement)的将由OpenGL库的开发者自行决定这里开发者是指编写OpenGL库的人。因为OpenGL规范并没有规定实现的细节具体的OpenGL库允许使用不同的实现只要其功能和结果与规范相匹配亦即作为用户不会感受到功能上的差异
- 原文中的斜体一律用加粗表示(中文并不存在斜体),粗体也用粗体表示,注意不要自己违反原文添加粗体
## 代码
- 文本中常量/代码用``加注为代码
@@ -60,13 +58,12 @@
- medium
- large
## 标题
- 每一节标题使用`#`h1标题(到后面会有几节有很多小节的,太小的标题不明显)
- 根据原文标题大小逐渐递增标题
- 注意`#`后与标题前要加一个空格
- 标题不要添加翻译,对于名词的翻译请写在文中
## 专有名词
@@ -142,6 +139,8 @@ $$
- 定义:`<def>Definition</def>`
- 函数及类名:`<fun>Program logic</fun>`
- 变量:`<var>Variables</var>`
- 标记的时候记得不要把中文翻译标记进去了
- 原文中的斜体如果译成中文一律用加粗表示(中文并不存在斜体),如果仍留为英文,请在单词两侧都添加空格与中文分开再改为斜体,粗体也用粗体表示,注意不要自己违反原文添加粗体
## 专业词汇对照表