# 文档小插件

**Repository Path**: cjlang/project-doc

## Basic Information

- **Project Name**: 文档小插件
- **Description**: node执行后生成的html，扫描项目结构，解析注释生成文档。
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-10-26
- **Last Updated**: 2024-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档小插件

#### 介绍
node执行后生成的html，扫描项目结构，解析注释生成文档。

scanfile.js 放在文件夹下，然后命令行执行：node scanfile.js


### 注释
/*
[{@开发者@}]

[{#文件或目录的简要说明#}]

[{*详细说明在这里描述*}]
*/

注释方式用//、/*、、/**等都可以，不同语言使用不同注释。
以上就是在文件中的注释格式.
如果要对文件夹注释，在文件夹下创建README.md，按照以上格式插入即可

#### 预览
![输入图片说明](demo.png)