feat: 添加了Docstring

README.md

@@ -64,7 +64,8 @@ backend/
 
 ```json
 {
-    "Carbon-Oxygen-": "CarbonDioxide"
+    "Carbon-Oxygen-": "CarbonDioxide",
+    "...": "..."
 }
 ```
 
@@ -76,10 +77,11 @@ backend/
 {
     "pics": {
         "Carbon": "cards/Carbon.png",
-        "Oxygen": "cards/Oxygen.png"
+        "Oxygen": "cards/Oxygen.png",
+        "...": "..."
     },
     "sounds": {
-        // ...
+        "...": "..."
     }
 }
 ```

app/routes/assets.py

@@ -1,3 +1,6 @@
+'''
+资源文件读取路由
+'''
 from flask import Blueprint, send_file
 from ..utils import assets
 

app/routes/cards.py

@@ -1,3 +1,6 @@
+'''
+卡牌定义文件读取路由
+'''
 from flask import Blueprint
 from ..utils import cards
 

app/routes/matters.py

@@ -1,3 +1,6 @@
+'''
+物质定义文件读取路由
+'''
 from flask import Blueprint
 from ..utils import matters
 

app/routes/pages.py

@@ -1,3 +1,6 @@
+'''
+网页路由
+'''
 from flask import Blueprint, jsonify
 
 page_bp = Blueprint("page", __name__, "/")

app/routes/reactions.py

@@ -1,3 +1,6 @@
+'''
+反应定义文件读取路由
+'''
 from flask import Blueprint
 from ..utils import reactions
 

app/utils/assets.py

@@ -1,3 +1,6 @@
+'''
+读取资源文件列表和路径
+'''
 import json
 
 def readAssetsList() -> dict:

app/utils/cards.py

@@ -1,3 +1,6 @@
+'''
+读取卡牌定义文件列表和内容
+'''
 import json
 
 def readCardList() -> dict:

app/utils/matters.py

@@ -1,3 +1,6 @@
+'''
+读取物质定义文件列表和内容
+'''
 import json
 
 def readMatterList() -> dict:

app/utils/reactions.py

@@ -1,3 +1,6 @@
+'''
+读取反应定义文件列表和内容
+'''
 import json
 
 def readReactionList() -> dict:

resources/conditions/list.json

@@ -0,0 +1,3 @@
+{
+    "Ignite": "Ignite"
+}