Numerous Problems Multiplied
Have ideas to improve npm?Join in the discussion! »

@higher/code-note

1.1.1 • Public • Published

根据注释生成笔记文件

起源

平时做项目可能会遇到大大小小的问题,如果不记录以后可能就忘记了,但是怎么记录呢?再去开个md编辑器不方便,可以直接写在代码里,然后通过此工具一键生成md,别人看你的代码还有可能得到启发

使用

请务必用多行注释

代码注释书写格式@note

/**
 * 给笔记起个标题吧
 * @note 在这里写笔记吧
 * @note 换行接着写,也可以
 * 这样写也ok
 */
<!-- 
  html注释也是支持的
  @note 在这里写注释
  @note 换一行
 -->
'''
python也是支持的
@note 这里写注释
'''

命令行

# 安装 
npm install @higher/code-note -g
# 切换到目录 
cd dir
# 执行命令 cn 目录 生成文件名 
cn . output # => ./output.md 

Install

npm i @higher/code-note

DownloadsWeekly Downloads

2

Version

1.1.1

License

MIT

Unpacked Size

5.05 kB

Total Files

5

Last publish

Collaborators

  • avatar