add naming.md

.vuepress/config.ts

@@ -115,6 +115,7 @@ export default defineUserConfig({
                     text: '开发',
                     children: [
                         '/dev/',
+                        '/dev/naming',
                         '/dev/PERM_PRIV',
                         '/dev/typescript',
                         '/dev/hook',

dev/README.md

@@ -15,6 +15,8 @@
 开发组不会为您解决任何网络问题。
 :::
 
+在开发之前，请务必确认您使用了支持 TypeScript 的 IDE 环境，这可以极大降低开发难度。
+
 ## 安装依赖
 
 - 系统要求：Hydro开发环境目前仅支持 Linux 系统，如您使用 Windows 请使用 WSL2 。

dev/naming.md

@@ -0,0 +1,32 @@
+# 命名规则
+
+## 变量命名规则
+
+在 Hydro 中的大部分变量有固定命名规则：
+
+- pdoc: 题目
+- tdoc: 比赛/作业/训练
+- rdoc: 提交记录
+- ddoc: 讨论
+- drdoc: 讨论的回复
+- drrdoc: 讨论的二级回复
+- mdoc: 站内信息
+- psdoc: 题目的提交状态
+- tsdoc: 比赛/作业的提交状态
+...
+
+以及它们的变种：
+
+- pdocs: 包含若干题目的数组
+- pdict: 键为题目 id，题目详情为值的对象
+...
+
+更多细节可在 packages/hydrooj/src/interface.ts 中找到。
+
+## 函数命名规则
+
+- `get()` 获取内容，返回对应值或 null
+- `getList()` 获取内容，返回 dict 类对象
+- `getMulti()` 获取数据库查询的指针
+- `edit()` 更新内容
+