《Node.js入门经典》一2.7 如何找模块文档

简介:

本节书摘来自异步社区《Node.js入门经典》一书中的第2章,第2.7节,作者【英】George Ornbo,更多章节内容可以访问云栖社区“异步社区”公众号查看

2.7 如何找模块文档

Node.js入门经典
在知道如何安装与寻找模块之后,我们还需要知道如何使用它们。通常来讲,Node.js模块都有编写良好的文档,可以通过运行如下命令在浏览器中查看模块文档:


5f485f8dc51dbe5552b612e371c041936cfdce89

这会打开浏览器并进入模块作者所提供的文档页面。这通常是一个指向 GitHub 上某个README文件的链接。要查看 underscore.js的文档,请运行:


8323f2498575f541e972c99c2b24c14fb9d649a7

通过运行如下命令也可以查看项目的bug:


a204e57390905bcebf8fe9cc2f64b23711ca406c

这会打开浏览器并进入模块作者所提供的问题页面。

随着读者越来越有经验,就会发现阅读模块的源代码是理解其作用的最快方法。


1ad033b0f12c08fc60ac306c745f960ea64a4c02

这里有个“意外”,那就是这个命令必须在Node.js项目文件夹的根目录下运行,而且该模块必须已经被下载到了node_modules文件夹中。


3dabaaa478379a9a8b0468a4b88ac473a526ac6b

大多数npm模块都托管在GitHub上,模块作者会对模块文档的贡献者极为感激。如果你在文档中发现了某些不足,可以考虑帮助作者改进文档。

相关文章
|
3月前
|
分布式计算 JavaScript 前端开发
超级实用!详解Node.js中的lodash模块和async模块
超级实用!详解Node.js中的lodash模块和async模块
|
2月前
|
JavaScript
Node.js【GET/POST请求、http模块、路由、创建客户端、作为中间层、文件系统模块】(二)-全面详解(学习总结---从入门到深化)
Node.js【GET/POST请求、http模块、路由、创建客户端、作为中间层、文件系统模块】(二)-全面详解(学习总结---从入门到深化)
27 0
|
12天前
|
域名解析 网络协议 JavaScript
【Node系列】node工具模块
Node.js有多个内置的工具模块,这些模块提供了用于执行各种任务的功能。
22 2
|
28天前
11_nest.js模块
11_nest.js模块
24 0
|
1月前
|
JavaScript 前端开发
Node.js之path路径模块
Node.js之path路径模块
|
1月前
|
JavaScript
Node.js之http模块
Node.js之http模块
|
2月前
|
JavaScript 前端开发 容器
 JavaScript 遍历文档生成目录结构
 JavaScript 遍历文档生成目录结构
18 1
|
2月前
|
资源调度 JavaScript 关系型数据库
Node.js【文件系统模块、路径模块 、连接 MySQL、nodemon、操作 MySQL】(三)-全面详解(学习总结---从入门到深化)
Node.js【文件系统模块、路径模块 、连接 MySQL、nodemon、操作 MySQL】(三)-全面详解(学习总结---从入门到深化)
33 0
|
3月前
|
JavaScript 前端开发 Java
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
175 0
|
3月前
|
JSON JavaScript 前端开发
Danfo.js专题 - 附:Dnotebook(Danfo Notebook)单机资源与汉化文档
Danfo.js专题 - 附:Dnotebook(Danfo Notebook)单机资源与汉化文档
51 0