zl程序教程

您现在的位置是:首页 >  后端

当前栏目

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

2023-09-11 14:17:39 时间

本节书摘来自异步社区《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上,模块作者会对模块文档的贡献者极为感激。如果你在文档中发现了某些不足,可以考虑帮助作者改进文档。


《Node.js入门经典》一导读 Node.js绝不仅仅只是服务器上的JavaScript。它是一个功能齐全的网络编程平台,能够针对现代Web编程的需求做出响应。
异步社区 异步社区(www.epubit.com)是人民邮电出版社旗下IT专业图书旗舰社区,也是国内领先的IT专业图书社区,致力于优质学习内容的出版和分享,实现了纸书电子书的同步上架,于2015年8月上线运营。公众号【异步图书】,每日赠送异步新书。