Autodocument

🚀 Autodoc 自動化文檔工具

Autodoc 是一款自動化文檔工具，能夠為代碼庫自動生成文檔、測試計劃和代碼審查反饋，幫助開發者提高工作效率，減少手動編寫文檔的工作量。

🚀 快速開始

📦 安裝指南

請訪問 發佈頁面 下載適合您操作系統的安裝包。

配置環境變量

在首次運行前，請設置以下環境變量：

• OPENROUTER_API_KEY：從 OpenRouter 獲取的有效 API 密鑰。
• MAX_FILE_SIZE_KB（可選）：限制每個目錄處理的最大文件大小，單位為 KB，默認值為 51200。
• MAX_FILES_PER_DIR（可選）：每個目錄允許處理的最多文件數，默認值為 200。

💻 使用示例

安裝完成後運行

node /path/to/autodoc/build/index.js

工具調用示例

基礎用法

以下是使用 Autodoc 自動生成文檔、測試計劃和代碼審查的基礎示例：

自動生成文檔

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "generate_documentation",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

自動生成測試計劃

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "autotestplan",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

自動生成代碼審查

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "autoreview",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

✨ 主要特性

自動生成文檔（generate_documentation）

為代碼庫生成全面的文檔，輸入參數如下：

• path：必填項，指定要處理的項目路徑。
• openRouterApiKey：可選，提供 OpenRouter API 密鑰，默認從環境變量讀取。
• model：可選，默認使用 "anthropic/claude-3-7-sonnet" 模型。
• updateExisting：可選，默認為 true，表示覆蓋現有文檔文件。

自動生成測試計劃（autotestplan）

為代碼庫生成詳細的測試計劃，輸入參數如下：

• path：必填項，指定要處理的項目路徑。
• openRouterApiKey：可選，提供 OpenRouter API 密鑰，默認從環境變量讀取。
• model：可選，默認使用 "anthropic/claude-3-7-sonnet" 模型。
• updateExisting：可選，默認為 true，表示覆蓋現有測試計劃文件。

自動生成代碼審查（autoreview）

生成高級別開發者對代碼庫的審查反饋，輸入參數如下：

• path：必填項，指定要處理的項目路徑。
• openRouterApiKey：可選，提供 OpenRouter API 密鑰，默認從環境變量讀取。
• model：可選，默認使用 "anthropic/claude-3-7-sonnet" 模型。
• updateExisting：可選，默認為 true，表示覆蓋現有審查反饋文件。

📚 詳細文檔

輸出文件說明

工具執行後會在指定目錄生成以下文件：

• 文檔文件：
  • documentation.md：包含項目的核心功能、設計思路和使用說明。
  • api_reference.md：記錄所有接口及其詳細信息。
• 測試計劃文件：
  • test_plan.md：列出所有需要執行的測試用例及優先級。
  • test_steps.md：詳細描述每個測試步驟和預期結果。
• 審查反饋文件：
  • review_report.md：記錄代碼審查過程中發現的所有問題和改進建議。

常見問題處理

錯誤碼說明

• ERROR_API_KEY_INVALID：API 密鑰無效或已過期。
• ERROR_PATH_NOT_FOUND：指定的路徑不存在或不可訪問。
• ERROR_FILE_SIZE_EXCEEDED：文件大小超出限制。
• ERROR_MAX_FILES_REACHED：處理的文件數量達到上限。

錯誤日誌查看

工具運行時會在控制檯輸出即時日誌，並在完成或中斷後生成 autodoc.log 文件，記錄所有操作和錯誤信息。

🔧 技術細節

項目貢獻

歡迎參與開源社區建設！請訪問 GitHub 倉庫 提交問題、功能請求或代碼貢獻。

⚠️ 重要提示

使用本工具前，請確保已仔細閱讀並理解相關文檔和技術規範，以獲得最佳的使用體驗。