Add Comments

ReportEngine/nodes/document_layout_node.py

@@ -37,7 +37,20 @@ class DocumentLayoutNode(BaseNode):
         query: str,
         template_overview: Dict[str, Any] | None = None,
     ) -> Dict[str, Any]:
-        """综合模板+多源内容，生成全书的标题、目录结构与主题色板"""
+        """
+        综合模板+多源内容，生成全书的标题、目录结构与主题色板。
+
+        参数:
+            sections: 模板切片后的章节列表。
+            template_markdown: 模板原文，用于LLM理解上下文。
+            reports: 三个引擎的内容映射。
+            forum_logs: 论坛讨论摘要。
+            query: 用户查询词。
+            template_overview: 预生成的模板概览，可复用以减少提示词长度。
+
+        返回:
+            dict: 包含 title/subtitle/toc/hero/themeTokens 等设计信息的字典。
+        """
         # 将模板原文、切片结构与多源报告一并喂给LLM，便于其理解层级与素材
         payload = {
             "query": query,
@@ -66,7 +79,18 @@ class DocumentLayoutNode(BaseNode):
         return design
 
     def _parse_response(self, raw: str) -> Dict[str, Any]:
-        """解析LLM返回的JSON文本，若失败则抛出友好错误"""
+        """
+        解析LLM返回的JSON文本，若失败则抛出友好错误。
+
+        参数:
+            raw: LLM原始返回字符串，允许带```包裹。
+
+        返回:
+            dict: 结构化的设计稿。
+
+        异常:
+            ValueError: 当响应为空或JSON解析失败时抛出。
+        """
         cleaned = raw.strip()
         if cleaned.startswith("```json"):
             cleaned = cleaned[7:]