文献综述--javascript在线api文档生成

《文献综述--javascript在线api文档生成》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、本科毕业设计文献综述（2012届）论文题目JavaScript在线API文档生成11JavaScript在线API文档生成引言随着现在软件工程的规模越来越大，参与项目的人数也越来越多，因此非常需要一些API文档来描述模块的功能，以让团队内的成员无需关心其它人的编码细节，减少沟通成本。而API文档的手动书写是一个漫长费时的过程，使用一些工具来生成API文档自然是最佳的解决方案。11一、关于JavaScript的研究1.1JavaScript语言背景JavaScript简称Js，是目前Web应用程序开发者使用

2、最为广泛的客户端脚本编程语言，它不仅可用来开发交互式的Web页面，更重要的是它将HTML、XML和Javaapplet、flash等功能强大的Web对象有机结合起来，使开发人员能快捷生成Internet或Intranet上使用的分布式应用程序。另外由于Windows对其最为完善的支持并提供二次开发的接口来访问操作系统各组件并实施相应的管理功能，JavaScript成为继.bat(批处理文件)以来Windows系统里使用最为广泛的脚本语言[1]。1.2脚本语言脚本语言是为了缩短传统的编写-编译-链接-运行（

3、edit-compile-link-run）过程而创建的计算机编程语言[2]。此命名起源于一个脚本“screenplay”，每次运行都会使对话框逐字重复。早期的脚本语言经常被称为批量处理语言或工作控制语言。一个脚本通常是解释运行而非编译。脚本语言通常都有简单、易学、易用的特性，目的就是希望能让程序员快速完成程序的编写工作。1.3JavaScript语言特性JavaScript作为一门脚本语言，具有较大的灵活性[3]。作者可以在代码任意位置定义和使用一个函数，也可以在任意变量读写属性。11一、关于API文档

4、生成的研究2.1API文档API（ApplicationProgrammingInterface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节[4]。API文档则是专门用于描述API的文档。比如比较有名API文档如java2api文档[5]。2.2现有的API文档生成技术目前主流的编程语言都有相应的文档生成工具，且这些工具也工作地很好，比如Java语言可以使用javadoc[6]来生成文档，生成的文档

5、非常精确。目前国外最有名的JS文档生成项目为JsdocToolkit[7]，它的工作原理是在书写文档的时候额外提供一些标记，以让文档生成工具更好地理解，确保最后生成的文档是正确的。这样做就让书写文档的工作量倍增。因此它不是完美的解决方案。2.3编译原理在API文档生成的应用编译是为了解析源码，并根据源码生成对应的可执行文件。现在的目标是API文档生成，因此需要用到编译技术中的词法分析和语法分析[8]技术，在词法分析同时，还需要额外进行API文档注释分析。1)词法分析一个词法分析器从输入中读取字符，并将它们

6、组成“词法单元对象”[9]。2)语法分析语法分析器从词法分析器获得一个由词法单元组成的串，并验证这个串可以由源语言的文法生成[9]。JavaScript语言遵循ECMA-262[10]语法规范，因此进行JavaScript语法分析时，必须严格按照其文档中的文法约定执行。JavaScript在语法上符合LR1规范，因此可以使用LR1生成器来定制适用于JavaScript的语法分析器。11图2-1语法分析的位置1)注释分析如果是一个完整的编译器，则需要后续的单元链接[11]、代码优化过程语法分析可以得到代码语

7、法树，通过遍历这棵树，可以分析出某个位置的注释的意义。2)文档合成分析注释的时候，将创建一个临时变量域，分析这个变量域可以提取整个文档数据，提取的文档数据被存储为XML文件，这个步骤称为文档合成。2.1基于DOM的XML文档解析技术XML(可扩展标记语言)是W3C为适应Internet的发展，实现快速的电子商务和电子数据交换而推出的新型web语言．它具有自描述性、数据结构高度规范、良好的扩展性、以及其数据与平台无关性等诸多优点[12]。文档对象模型DOM(DocumentobjectModel)是W3C为

8、在内存中建立XML文档的树结构提供的一种标准规范，XML文档中的每个元素、属性、CDATA部分等都可以用DOM树结构中的节点来表示。DOM是处理XML数据的传统方法。使用DOM时，数据以树状结构的形式被加载到内存中[13]。11一、关于在线API文档的研究3.1在线API文档传统的API文档都是一个类似word的本地数据文件，它确实完成了API文档所应该拥有的功能。但在web2.0[14]时代，如果能让更多人通过网页参与API