Skip to content

Commit 7d1def2

Browse files
committedJun 30, 2022
feature: 移动开发者手册Python相关到本手册
1 parent 3c11427 commit 7d1def2

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed
 

‎README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# Python工程实践
1+
# 量潮Python手册
2+
3+
本手册是量潮在Python编程语言实践的指导性手册。

‎code_style/hint.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# 注释
2+
3+
- 模块写模块注释,函数和类写函数和类注释,代码块写注释;
4+
- 需要尽量简洁,比如使用动名词。

‎code_style/naming.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# 命名规范
2+
3+
## 类命名
4+
5+
通常情况下,各个语言的类名都是采用`QCloudAPIClient`的方式命名。这样的命名在OSRM(地图API)、COS(对象存储)等产品缩写时遇到问题,会出现可读性比较差的“OSRMAPIClient”的命名。
6+
7+
我们讨论了“OsrmApiClient”和“OsrmAPIClient”,最终打算采用后者,对于API、SDK等行业通用的概念,保留大写缩写以提高可读性。
8+
9+
因此,关于类名的大小写规范明确如下:
10+
11+
- 通常情况下使用“ClassName”即可。
12+
- 对于行业通用的概念,比如API、SDK等,在类名中保留其全大写;对于OSRM、COS、EIAM等产品名称,则使用首字母大写的方式。比如`OsrmAPIClient`

‎requirements.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# 依赖
2+
3+
- 用什么依赖需要严格讨论,团队内部尽量保持一致、和教程保持一致。
4+
- 尽量使用官方方案或者主流方案。

0 commit comments

Comments
 (0)
Please sign in to comment.