30 lines
772 B
Markdown
30 lines
772 B
Markdown
|
# 天府股交项目-应用端API接口
|
||
|
|
版本信息: WideRating APP API TFSE v0.2x
|
||
|
|
|
||
|
|
## 命名备注
|
||
|
|
|
||
|
|
### 命名格式
|
||
|
|
包括文件命名、对象命名、函数命名等格式规范
|
||
|
|
|
||
|
|
| 类型 | 方法 | 示例 |
|
||
|
|
| ---- | ---- | ---- |
|
||
|
|
| 对象 | 首字母大写 | Class User: |
|
||
|
|
| 一般函数 | 小写字母加下划线 | def get_user_info(): |
|
||
|
|
| 数据操作函数 | 大写字母加下划线 | def FIND_USER_DATA(): |
|
||
|
|
|
||
|
|
### 命名简写
|
||
|
|
在保证代码可读性的前提下，为了让代码排版显得清爽，需要简写一些较长且常用的英文
|
||
|
|
|
||
|
|
| 简写 | 全写 | 中文 |
|
||
|
|
| :----: | :----: | :----: |
|
||
|
|
| cc | comprehensive_credit | 综合信用 |
|
||
|
|
| impl | implement | 实施 |
|
||
|
|
| CC | COMPREHENSIVE_CREDIT | 综合信用 |
|
||
|
|
| REQ | REQUIREMENT | 要求 |
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|