文档章节

JsDoc

十万猛虎下画山
 十万猛虎下画山
发布于 2018/03/29 14:30
字数 145
阅读 16
收藏 0

https://zhuanlan.zhihu.com/p/30280276

 

JsDoc 不处理以“_”开头的JS文件解决办法:

原地址

This behavior is intentional. The default configuration file is set up to exclude files and folder names that begin with an underscore.

To change the default behavior:

  1. Copy conf.json.EXAMPLE to a new file, conf.json. You can put it in the JSDoc directory or another directory. If you put it in another directory, you will need to use the -c option to tell JSDoc where to find it: jsdoc -c path/to/conf.json
  2. Open conf.json in a text editor.
  3. Find the source.excludePattern property, and change it to an empty string.

We could definitely use better docs for this, so I made a note on a related issue in the documentation project: jsdoc3/jsdoc3.github.com#4

Hope that helps!

© 著作权归作者所有

十万猛虎下画山
粉丝 6
博文 130
码字总数 98614
作品 0
朝阳
程序员
私信 提问
JavaScript API 文档工具--JsDoc 3

JSDoc 3 是一个根据 Javascript 文件中注释信息,生成 JavaScript 应用、库、模块的 API 文档的工具。你可以使用它记录如:命名空间、类、方法、方法参数等。 JSDoc 3 需要 Node.js 4.2.0 及...

匿名
2009/10/16
1K
0
使用grunt-jsdoc自动化生成javascirpt文档

背景 Javascript已经成为一门被人们重新认识的编程语言,由于大量JS开源框架的出现,利用Javascript开发的项目越来越多,越来越大。同时,也有越来越多Javascript开发问题暴露出来,如性能、...

knightuniverse
2013/08/29
0
1
利用jsdoc为vue项目生成漂亮的文档

jsdoc是前端自动生成文档所常用的工具。我们只要按照jsdoc的语法来书写注释就能顺利的生成一片很漂亮的文档。 只是jsdoc针对的是文件,对于文件似乎就有些无能为力了。不过既然这么人气,相信...

吃土的小此方
2018/01/14
0
0
JsDoc Toolkit 简介

JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 Java...

红薯
2009/10/16
2.4K
1
使用JSDoc自动生成代码文档

译者按: 代码要有规范的注释,遵从jsDoc规则来注释可以生成有用的文档。 原文: Generate docs and host it with JSDoc and GitHub Pages 译者: Fundebug 为了保证可读性,本文采用意译而非直...

Fundebug
2017/10/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

RocketMQ的事务投递

RocketMQ的事务投递 这是阿里的分布式事务图: 1、A服务先发送个Half Message给Brock端,消息中携带 B服务 即将要+100元的信息。 2、当A服务知道Half Message发送成功后,那么开始第3步执行本...

春哥大魔王的博客
24分钟前
1
0
Qt编写自定义控件31-面板仪表盘控件

一、前言 在Qt自定义控件中,仪表盘控件是数量最多的,写仪表盘都写到快要吐血,可能是因为各种工业控制领域用的比较多吧,而且仪表盘又是比较生动直观的,这次看到百度的echart中有这个控件...

飞扬青云
29分钟前
3
0
DisplayPort 迎来重大更新,数据带宽性能提高3倍

VESA宣布了他们对DisplayPort接口三年来的第一次重大更新。 与DP 1.4a相比,DisplayPort 2.0提供了三倍于DP 1.4a的数据带宽性能,支持超过8K的分辨率,更高的刷新率和更高分辨率的HDR,以及其...

linuxCool
37分钟前
1
0
《Linux就该这么学》2019年7月20日第八天上课笔记

du命令 du -sh /newFS/ 察看文件/文件夹数据占用量 SWAP 交换分区的设置 磁盘容量配额 RHEL 5/6 usrquota RHEL 7 quota 软硬连接 ln 软 指针指向inode 硬 建立新的inode RAID 0 1 5 1+0...

2lodoss
39分钟前
1
0
适合钱包应用开发的ERC20代币数据集

Erc20Tokens数据集包含超过1000种主流的以太坊ERC20代币的描述数据清单和图标,可用于钱包等区块链应用的开发,支持使用Java、Python、Php、NodeJs、C#等各种开发语言查询主流ERC20代币的相关...

汇智网教程
今天
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部