官方文檔指引

提示：若不計劃發布到應用市場，可省略圖片等非必要功能

參考文檔：https://doc.buildadmin.com/senior/module/basicInfo.html

---

---

開發說明

目標：將現有功能模塊打包移植到新環境

功能模塊示例：

• 朋友圈
• 商品管理
• 收貨地址
• 分銷系統

開發建議：

1. 按功能劃分獨立模塊（如公共模塊public、商品goods、訂單order）
2. 采用駝峰命名（如朋友圈模塊命名為circleOfFriends）
3. 在Markdown中清晰標注模塊邏輯
4. 同步記錄相關數據結構至Markdown
5. 將API文檔置于項目目錄中
6. 配置項命名規范（如circleOfFriendsId、circleOfFriendsXxxx）
7. 遵循高內聚低耦合原則，減少跨模塊調用
8. 使用Git進行版本控制，首發版本建議1.0.0
9. 版本號規范：
   • 測試版：1.0.1-beta.1
   • 功能迭代：1.x.x
   • 重大更新：x.0.0

---

核心文件說明：重點關注以下3個文件

1. info.ini - 作者信息
2. install.sql - 數據庫腳本
3. config.json - Composer包配置

模塊開發流程

模塊包結構示例

安裝開發工具

1. 從應用商店安裝"模塊開發輔助"插件
   

2. 安裝完成后刷新即可查看已安裝模塊
   

3. 創建新文件夾并復制核心文件，刷新后即可看到新模塊
   

4. 點擊模塊第一個按鈕 選中左側文件 打包按鈕選擇對應文件，完成模塊打包
   

---

總結

打包完可以多測試幾次 最好用他們新框架純凈環境多試幾次。

1. 模塊劃分

   • 將各模塊單獨存放，例如：public公共塊、goods商品模塊、order訂單模塊
   • 模塊命名采用駝峰式，如朋友圈模塊命名為circleOfFriends

2. 文檔規范

   • 在Markdown文件中明確標注模塊相關邏輯
   • 將對應數據結構同步記錄在Markdown文件中
   • API文檔統一存放在項目目錄下

3. 配置管理

   • 配置項命名遵循模塊前綴原則，如：circleOfFriendsId、circleOfFriendsXxxx

4. 代碼設計

   • 遵循高內聚、低耦合原則
   • 避免模塊間過度依賴，如存在大量交叉調用，應考慮合并為新模塊

5. 版本控制

   • 使用Git進行版本管理
   • 首發版本號建議采用1.0.0
   • 測試版命名規范：1.0.1-beta.1
   • 復雜功能迭代可采用增量版本：1.x.x或x.0.0表示大版本更新