0.1.1 • Published 2 years ago

@wx-xingdong/m-doc v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

✨ 特性

  • 方法流程记录以及可视化展示
  • API 方法自动解析以及生成
  • 支持 Markdown 语法进行 API 注释以及描述

📦 安装

yarn add babel-plugin-m-doc m-doc -D

🧐 Usage

配置 Babel 插件

方法标记

使用 @doc 进行方法注释标记,仅对标记的方法进行记录,并生成 API 文档

// @doc 方法 a
const a = () => {
  console.log('function a called')
}

/**
 * @doc 主方法
 */
function main () {
}

License

MIT

Copyright (c) 2022 Dong Xing