Update coding_conventions.md

This commit is contained in:
tangdou1 2020-03-25 10:55:51 +08:00 committed by GitHub
parent a80472a45e
commit 7a93056b5a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions

View File

@ -1,20 +1,20 @@
# 如果您想与ZeroNet合作则遵守编码标准 # 如果您想与ZeroNet合作则遵守编码标准
- 遵循 [PEP8](https://www.python.org/dev/peps/pep-0008/) - 遵循 [PEP8](https://www.python.org/dev/peps/pep-0008/)
- 简单比复杂 - 简单比复杂好
- 过早优化是万恶之源 - 过早优化是万恶之源
### 命名 ### 命名规则
- ClassNames: Capitalized, CamelCased - 类名(ClassNames): 大写, 骆驼命名法
- functionNames: starts with lowercase, camelCased - 函数名(functionNames): 以小写字母开头, 骆驼命名法
- variable_names: lowercased, under_scored - 变量名(variable_names): 小写, 下划线
### 变量 ### 变量
- file_path: File path realtive to working dir (data/17ib6teRqdVgjB698T4cD1zDXKgPqpkrMg/css/all.css) - 文件路径(file_path): 相对于工作文件夹的文件路径(data/17ib6teRqdVgjB698T4cD1zDXKgPqpkrMg/css/all.css)
- inner_path: File relative to site dir (css/all.css) - 内部路径(inner_path): 相对于站点文件夹的文件路径(css/all.css)
- file_name: all.css - 文件名(file_name): all.css
- file: Python file object - 文件(file): Python文件对象
- privatekey: Private key for the site (without _) - 私钥(privatekey): 站点私钥(没有下划线)
### 源文件目录和命名 ### 源文件文件夹和命名
- 每个文件一个类是首选 - 最好一个文件代表一个类
- 源文件名和目录来自ClassName: WorkerManager class = Worker/WorkerManager.py - 源文件名和目录来自类名(ClassName): WorkerManager类 = Worker/WorkerManager.py