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

2.7 如何找模块文档

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

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

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

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

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

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

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

时间: 2024-10-16 02:55:34

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

《Node.js入门经典》一1.3 安装并创建第一个Node.js程序

1.3 安装并创建第一个Node.js程序 Node.js入门经典 说得够多的了!现在来看看运行中的Node.js并编写你的第一个Node.js程序.首先得安装 Node.js.用于Windows 和 OSX 的安装程序可以在 Node.js 的主页下载:http://nodejs.org/.要想在这些平台上安装Node.js,只需下载相关文件并双击安装程序即可.如果使用Linux或者想手动编译Node.js,请在https://github.com/joyent/node/wiki/insta

《Node.js入门经典》一2.4 使用模块

2.4 使用模块 Node.js入门经典 要在Node.js应用程序中使用模块,在下载它们之后必须请求(require)它们.在应用程序中请求一个模块的方法如下: 现在,当应用程序运行的时候,它将在源文件中找库(library)并将其包含在应用程序中.通常我们要使用这个模块,所以我们将其赋予一个变量. TRY IT YOURSELF 如果下载了本书的代码示例,那么这段代码可在hour02/example01找到.要在Node.js中使用第三方模块,请遵照如下这些步骤进行. 1.打开文本编辑器,编

《Node.js入门经典》一1.2 使用Node.js能做什么

1.2 使用Node.js能做什么 Node.js入门经典 Node.js是个程序设计平台,只要有想法和足够的编程技艺,它就无所不能.它既可以创建对文件系统进行操作的小段脚本,也可以创建大规模的Web应用程序来运行整个业务.由于Node.js的独特设计,它非常适合于多人游戏.实时系统.联网软件和具有上千个并发用户的应用程序. 以下是一些使用Node.js的公司. LinkedIn eBay Yahoo! Microsoft 能使用Node.js创建的应用程序有: 实时多人游戏: 基于Web的聊天

《Node.js入门经典》一导读

前言 Node.js入门经典 Node.js可以让开发人员在服务器上使用JavaScript,这让熟悉JavaScript的开发人员又多了一种服务器端的开发技能,但Node.js并非仅限于此.它重新思考了在现代Web环境下的网络编程,在这个环境下,应用程序可能需要从许多不同的地方读写数据,也可能有上百万个并发用户. 在具有传统的计算机科学学位的开发人员眼中,JavaScript就是一种玩具语言.但是,JavaScript已经经历了无数次的挑战,而且如今在Web的浏览器和服务器端(借助于Node.

《Node.js入门经典》一1.4 小结

1.4 小结 Node.js入门经典 好极了!你刚刚创建并运行了第一个Node.js程序.虽然你现在不太可能以Internet百万富翁的身份退休,但以这个简单的示例为基础,在将来的几章里你将可以创建出更为复杂的应用程序,包括一个聊天服务器和一个实时的Twitter客户端. 除了创建一个简单的服务器以外,在本章我们还学到:Node.js运行在V8引擎之上,这是一个由Google开发的开源的JavaScript引擎.我们还了解到Node.js有多种用途,且精于创建有上千个并发用户的联网应用程序. 在

《Node.js入门经典》一2.6 本地和全局的安装

2.6 本地和全局的安装 Node.js入门经典 可以使用npm以两种方式安装模块,理解它们的工作方式很重要. 2.6.1 本地安装 本地安装意味着库将安装在项目本地的一个名为node_modules的文件夹下(在安装underscore库时就是如此)以便项目使用.这是默认行为,只要运行如下命令,就是如此: 如果Node.js应用程序的名称是foo.js,这将产生如下的文件夹结构: 这是最为常见并且推荐的安装Node.js模块的方法. 2.6.2 全局安装 有些模块带有可执行文件,你希望能够在文

《Node.js入门经典》一2.10 问与答

2.10 问与答 Node.js入门经典 问:我刚刚开始学习使用Node.js,我应当使用模块吗? 答:是的.通过使用模块可以快速地给应用程序加入许多功能.模块通常可以为开发人员除去常见的困难.比如,Express模块让使用Node.js进行Web开发变得简单. 问:有许多模块可以解决我的问题,哪个模块最好? 答:你应当使用社区中最为流行的模块.可以通过使用位于http://blago.dachev.com/modules和http://eirikb.github.com/nipster/的搜索

《Node.js入门经典》一2.5 如何找模块

2.5 如何找模块 Node.js入门经典 既然可以安装Node.js模块,就会想探究有哪些模块是可用的.Node.js有一个充满生机的开发者社区,模块的建立和维护每天都在发生. 2.5.1 官方来源 你可以在许多地方搜索模块.首先,在http://search.npmjs.org/上有一个官方的基于Web的npm搜索工具(见图2.3).这是寻找第三方模块的正统资源.请尝试搜索"irc",读者将看到有许多和irc有关的模块以及模块的简要介绍. 一旦找到了要找的模块,就可以按先前的方法在

《Node.js入门经典》一2.11 测验

2.11 测验 Node.js入门经典 本测验包含一些问题,可帮助读者巩固本章所学的知识. 问题 1.什么是模块? 2.模块的本地安装和全局安装有什么区别? 3.在管理模块时,使用package.json文件有什么优势? 答案 1.模块是可重用的代码库.比如用来与数据库交互的模块.支持Web开发的模块以及通过Web套接字协助通信的模块. 2.本地安装模块意味着模块会被安装在项目内名为node_modules的文件夹中,而且它只可在该项目中使用.全局安装模块意味着该模块可在系统的任何一个地方使用.

《Node.js入门经典》一1.5 问与答

1.5 问与答 Node.js入门经典 问:我能在服务器上使用JavaScript吗?JavaScript不是只能在浏览器上用吗? 答:JavaScript绝对可以用在服务器上,而且,它的许多特性使其精于此道.编写服务器端的JavaScript有许多好处,尤其在需要处理并发的时候.如果读者有使用诸如jQuery这样的框架编写JavaScript的经验,就会在Node.js中看到相似的模式. 问:创建Web应用程序,Node.js比PHP.Python..NET或Ruby好吗? 答:要评估哪个编程