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

xiaoxiao2024-03-28 10

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

2.7　如何找模块文档

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

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

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

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

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

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

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