毕业设计-javascript在线api文档生成.docVIP

本科毕业设计说明书（论文） （201届） 摘要 JavaScript 是目前最流行的脚本语言。它起初是为网页提供交互能力而设计的一门基于对象的普通脚本语言。但随着一些Web新标准的出现和一些像Nodejs之类的JavaScript客户端宿主程序的流行，JavaScript的用途也越来越广，一个JavaScript的项目也随之变大。因此现在对JavaScript项目的API文档的需求也迅速膨胀。 为了将作者从手动书写API文档的繁琐过程中解脱出来，必须要有一个强大的工具能够提取代码中的注释，并自动生成一份完整的API文档。传统的一些JavaScript文档生成项目，比如jsdoc，只能生成比较简单的文档，无法很好地满足现在的新需求。本文研究对JavaScript源码中的注释进行解析，然后提取有用的API信息，并最后生成一个完整的文档页面供读者阅读。解析过程充分考虑了JavaScript语言的灵活特性，让JavaScript源码作者可以快速地为自己的代码生成对应的文档。 同时为了方便用户进行文档生成操作，使用C#开发一个WinForm软件。生成的文档是一个普通的网页，用户可以自定义文档界面模板。生成的文档可以放在ASP.NET服务器上直接运行。读者可以在线阅读文档，并在文档的任何一页添加评论。 关键词：JavaScript, API, 文档生成, WinFormAbstract JavaScript is the most popular script language nowadays, which is designed as a simple object-based script language to provide the ability of interaction for web pages at first. But along with the appearance of new web standards and the popularity of some JavaScript clients like Nodejs, the usage of JavaScript increases soon and the JavaScript projects become more complex, which leads to new requirement of JavaScript documentation as well. To avoid authors writing API Document word by word, there should be a powerful tool to export an API document from the source code automatically. The traditional related projects such as Jsdoc show their shortcoming when meeting new requirements. This article focuses on analyzing source code of JavaScript and then generating a full API document. The analyzing program is fit for JavaScript, which can save a lot of time for JavaScript authors. This article also talks about developing a program of WinForm to make it easier to operate. On the other hand, users can custom the templates of document if needed. The generated API document can run on ASP.NET server directly. Readers can view the document online and leave their comments on any page. Keywords：JavaScript, API, Document Generator, WinForm 目录 摘要 I Abstract I 第一章 绪论 3 1.1 研究开发的目的 3 1.2 国内外研究发展现状 4 1.3 研究开发的基本目标 4 1.4 本文的组织结构 5 第二章 方法与技术 6 2.1