Commit f2ca100

authored

Update README.md

1 parent df3149f commit f2ca100Copy full SHA for f2ca100

File tree

-0

lines changed

-0

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -36,6 +36,15 @@ just add `@vue` tag, `@exports` tag, to the to document in you vue SFC.
`36`	`36`	`export default {}`
`37`	`37`	```
`38`	`38`
	`39`	`+## 如何使用jsdoc?`
	`40`	`+`
	`41`	+- 安装jsdoc: `npm i jsdoc -D`
	`42`	+- 安装模板:`npm i sherry-docstrap -D`, 原来的[docstrap](https://github.com/docstrap/docstrap)有点小bug还未修复,所以自己暂时发布一个。
	`43`	`+- 在项目目录下建了配置文件:下面有示例,适当修改。`
	`44`	+- 在pacakge.json 里添加一个script: `"jsdoc": "rm -rf public/jsdoc && node_modules/.bin/jsdoc -c jsdoc.json"`, `public/jsdoc`为发布位置,适当修改
	`45`	+- 生成文档: `npm run jsdoc`
	`46`	`+`
	`47`	`+`
`39`	`48`	`## jsdoc.json`
`40`	`49`
`41`	`50`	```json

Comments

(0)