Miao-Yunzai/md/developer.md

1.6 KiB
Raw Blame History

开发者需知

未来将支持TS、TSX环境提供Miao-Yunzai完全的类型声明及其开发文档。

  • 提交
/**
 * feature新功能
 * update更新某功能
 * fix修补某功能
 * refactor重构某个功能
 * optimize: 优化构建工具或运行时性能
 * style仅样式改动
 * docs仅文档新增/改动
 * chore构建过程或辅助工具的变动
 */
  • 注释风格
/**
 * 返回false
 * @param T 任意字符串
 * @returns false
 */
function getTest(T: string) {
  return false
}
  • 命名风格
// 获得test值
function getTest(T: string) {}
// 设置
function setTest(T: string) {}
// 删除
function delTest(T: string) {}
// 获取某数据依据为id
function getDataById(T: string) {}

// 系统常量
const ENV_TEST = 'dev'

// 局域常量
const MyName = 'yunzai'

// 可修改变量
let values = ''

// 禁止使用 var values = ''

// 声明数组
const Arr = []

// 不推荐  new

// 声明对象
const Obj = {}

// 不推荐new

关于lib目录

lib目录将在未来逐渐放弃在版本发布后开发者需要有意识的对此变化做出调整.

// 已废弃
--lib / puppeteer
// 无扩展性,计划废弃
--lib / renderer
// 非机器人框架的核心处理代码
// 消耗服务器内存,无扩展性,计划废弃
--lib / tools / web.js / test.js / log.js / ksr.js
// 计划废弃
--renderers

// 其他内容逐步优化。。。

新版目录

  • 核心源码

src/core

  • 配置管理

src/config

  • 数据管理

src/db

  • 接口板块

src/mys

  • 工具类

src/utils

新开发示例

开发示例