01-About Documentation

最新推荐文章于 2022-11-09 15:45:40 发布
最新推荐文章于 2022-11-09 15:45:40 发布
阅读量684 收藏
点赞数
分类专栏： 译node.js
本文介绍了Node.js官方文档的三种类型：参考文档提供了详细的API版本信息及使用细节；入门资料帮助初学者理解Node.js的基本概念；教程则针对具体应用场景提供深入指导。所有文档专注于Node.js内置模块。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

s

About Documentation

  我们认为文档对于用户很重要，但是不同的用户对文档的要求也不一样。所以，在nodejs.org上，你会看到三种类型的文档：

1、reference documentation

2、getting started documentation

3、tutorials


  API reference documentation主要是提供方法或pattern详细的版本信息，通过这个文档你可以明确方法的参数列表和返回值，以及相关的错误信息（异常？或是返回值的error code？不清楚，暂且这样认为吧）。并且通过这个文档你也可以识别不同版本的node.js该使用过哪个方法。（可能最新的方法在老的版本中不支持，或者有些方法在新的版本中已经废弃）


  Getting Started materials 是为了让你轻松入门、理解Node中的一些概念。通常是一些简单的代码片断，以帮助你理解Node中设计模式，同样在社区中的其它模块中你也会看到类似的模式。


  Tutorials是稍高级点的主题、文档，旨在指导用户详细的使用Node的用例。其主要强调Node的不同使用方法，但不讨论它与社区中第三方模块的异同。


    所有的文档只涉及Node内建的模块，Node对争谁更牛逼没兴趣，我们只客观地讨论我们的API。


s



s

01-Introducing the Arm architecture
baron-周贺贺-代码改变世界ctw
10-05 963
目录1、Overview2、About the Arm architecture3、架构(architecture)到底是什么意思呢4、Architecture and micro-architecture5、Arm architecture的版本6、Arm documentation的定义 1、Overview Arm architecture为 processor 或 core的设计提供了基础，通常我们可以将processor 或 core称为Processing Element(PE)。 Arm 架构
【SemiDrive源码分析】【Yocto源码分析】01 - yocto/base目录源码分析（编译环境初始化流程）
|~~~热爱生活、努力学习的小伙汁~~~|
05-03 3851
【SemiDrive源码分析】【Yocto源码分析】01 - yocto/base目录源码分析（编译环境初始化流程）
之外的非空格字符。发现了 'Web Authentication'
masaida的博客
07-25 5401
方案元素中不允许出现除 'xs:appinfo' 和 'xs:documentation' 之外的非空格字符。发现了 'Web Authentication'。  at org.springframework.beans.factory.parsing.FailFastProblemReporter.error(FailFastProblemReporter.java:70) 解
Apollo 本地启动
走在命运的左岸
06-22 3355
Apollo 本地启动 背景 项目接入 Apollo 后，IDEA 配置 Configuration --> VM options 指向开发环境配置 开发环境配置设置了IP访问限制，导致本地服务启动异常 Apollo 配置的缓存文件只有当开发环境配置获取不到时才会读取缓存配置，而不是直接读取缓存配置信息，所以通过修改本地缓存配置信息无法达到修改配置信息的目的 项目启动 切换项目分...
xsi:schemaLocation报错
热门推荐
Bleach_max的博客
07-26 5万+
org.springframework.beans.factory.xml.XmlBeanDefinitionStoreException: Line 10 in XML document from class path resource [chapter2-servlet.xml] is invalid; nested exception is org.xml.sax.SAXParseExcep
SpringMVC整合MyBatis报错
一位自然人的博客
09-28 557
** SpringMVC整合MyBatis报错 ——通配符的匹配很全面, 但无法找到元素 ‘mvc:annotation-driven’ 的声明 ** ERROR [http-nio-8080-exec-4] - Context initialization failed org.springframework.beans.factory.xml.XmlBeanDefinitionStoreExc...
HSENARP-About
03-11
6. **文档（Documentation）**：提供如何使用HSENARP的指南或API参考。 7. **社区（Community）**：指向论坛、GitHub仓库或其他交流平台的链接，以便用户提问和分享经验。 8. **联系方式（Contact）**：提供联系项目...
Sun About Solaris 8 Documentation -43
06-19
《太阳公司关于Solaris 8文档的介绍》 本文档主要涵盖了Sun Microsystems公司关于Solaris 8操作系统的重要信息。Solaris是由Sun Microsystems开发的一款高级操作系统，尤其在企业级服务器领域广泛应用。...
Flask Documentation
02-06
Flask官方文档：This part of the documentation, which is mostly prose, begins with some background information about Flask, then focuses on step-by-step instructions for web development with Flask
nested exception is org.xml.sax.SAXParseException; systemId: http://app.mamalaile.com.cn/android/dub
qq_30616169的博客
01-23 4157
2018-01-23 14:10:42 INFO  ClassPathXmlApplicationContext:513 - Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@32eebfca: startup date [Tue Jan 23 14:10:42 CST 2018]; root
Linux/Documentation/io_ordering.txt
u012036443的专栏
11-15 1478
Chinese translated version of Linux/Documentation/io_ordering.txtIf you have any comment or update to the content, please contact theoriginal document maintainer directly.  However, if you have a prob
关于web.xml文件中配置中带有“*”
weixin_51182359的博客
05-04 507
通配符对于我们访问资源时的影响
因lxml版本造成的HTML解析问题
m0_48028588的博客
11-09 562
因lxml版本造成解析结果出现偏差的问题
注释中不允许出现字符串 "--"。
weixin_33853794的博客
07-25 1481
问题： 　　在启动tomcat时会出现如上错误，同时有可能会出现xml无法解析等错误 解决办法： 注释中不能出现字符串 "--"，即需要把xml文件中多余的“--”去掉，例如： <!-- ---------Department和User对应,外键设置在多的一方,column为外键名------- --> 应该改为 <!--Department和User对应,外键设...
Invenio Documentation(一)
Alan Zhuang的博客
06-20 2591
Invenio是一个开源的框架
XMLSchema 注解
zhengyeqing520的专栏
12-22 5762
XMLSchema 注解<br />注解<br />在XML文档中提供附加信息的通常方式是使用注释，即在"<!--"和"-->"之间给出注释信息。在XML Schema中，注释仍然可以使用，不过为了方便其他读者和应用程序来理解模式文档，XML Schema提供了三个元素来为模式提供注解。这三个元素是：xs:annotation、xs:documentation和xs:appinfo，其中xs:documentation和xs:appinfo是作为xs:annotation元素的子元素使用的。xs:docum
sql server 中的特殊空格（并提供修改存储过程）
双花诞
11-22 4258
好多字段中会有不是空格的空字符，但又不一定是制表符，弄得整个表很乱，所以下面最后一个[]中就是这个字符的通配符了，本身是属性值，没法选中，但可以直接复制匹配。 SELECT DISTINCT a FROM  tb_1 WHERE  a IS NOT NULL AND  a LIKE '%[吖-座]%' AND  a LIKE '%[]%'
The Network Simulator, Version 3 -------------------------------- Table of Contents: ------------------ 1) An overview 2) Building ns-3 3) Running ns-3 4) Getting access to the ns-3 documentation 5) Working with the development version of ns-3 Note: Much more substantial information about ns-3 can be found at http://www.nsnam.org 1) An Open Source project ------------------------- ns-3 is a free open source project aiming to build a discrete-event network simulator targeted for simulation research and education. This is a collaborative project; we hope that the missing pieces of the models we have not yet implemented will be contributed by the community in an open collaboration process. The process of contributing to the ns-3 project varies with the people involved, the amount of time they can invest and the type of model they want to work on, but the current process that the project tries to follow is described here: http://www.nsnam.org/developers/contributing-code/ This README excerpts some details from a more extensive tutorial that is maintained at: http://www.nsnam.org/documentation/latest/ 2) Building ns-3 ---------------- The code for the framework and the default models provided by ns-3 is built as a set of libraries. User simulations are expected to be written as simple programs that make use of these ns-3 libraries. To build the set of default libraries and the example programs included in this package, you need to use the tool 'waf'. Detailed information on how use waf is included in the file doc/build.txt However, the real quick and dirty way to get started is to type the command ./waf configure --enable-examples followed by ./waf in the the directory which contains this README file. The files built will be copied in the build/ directory. The current codebase is expected to build and run on the set of platforms listed in the RELEASE_NOTES file. Other platforms may or may not work: we welcome patches to improve the portability of the code to these other platforms. 3) Running ns-3 --------------- On recent Linux systems, once you have built ns-3 (with examples enabled), it should be easy to run the sample programs with the following command, such as: ./waf --run simple-global-routing That program should generate a simple-global-routing.tr text trace file and a set of simple-global-routing-xx-xx.pcap binary pcap trace files, which can be read by tcpdump -tt -r filename.pcap The program source can be found in the examples/routing directory. 4) Getting access to the ns-3 documentation ------------------------------------------- Once you have verified that your build of ns-3 works by running the simple-point-to-point example as outlined in 4) above, it is quite likely that you will want to get started on reading some ns-3 documentation. All of that documentation should always be available from the ns-3 website: http:://www.nsnam.org/documentation/. This documentation includes: - a tutorial - a reference manual - models in the ns-3 model library - a wiki for user-contributed tips: http://www.nsnam.org/wiki/ - API documentation generated using doxygen: this is a reference manual, most likely not very well suited as introductory text: http://www.nsnam.org/doxygen/index.html 5) Working with the development version of ns-3 ----------------------------------------------- If you want to download and use the development version of ns-3, you need to use the tool 'mercurial'. A quick and dirty cheat sheet is included in doc/mercurial.txt but reading through the mercurial tutorials included on the mercurial website is usually a good idea if you are not familiar with it. If you have successfully installed mercurial, you can get a copy of the development version with the following command: "hg clone http://code.nsnam.org/ns-3-dev"
最新发布
03-08
| **新手教程** | [官方教程](http://www.nsnam.org/documentation/latest/) | | **模型库说明** | 包含所有内置模型的详细说明 | | **API参考手册** | [Doxygen生成文档](http://www.nsnam.org/doxygen/index.html)...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值