JavaScript在线API文档生成.doc

本科毕业设计说明书（论文）（2012届）论文题目JavaScript在线API文档生成32摘要JavaScript是目前最流行的脚本语言。它起初是为网页提供交互能力而设计的一门基于对象的普通脚本语言。但随着一些Web新标准的出现和一些像Nodejs之类的JavaScript客户端宿主程序的流行，JavaScript的用途也越来越广，一个JavaScript的项目也随之变大。因此现在对JavaScript项目的API文档的需求也迅速膨胀。为了将作者从手动书写API文档的繁琐过程中解脱出来，必须要有一个强大的工具能够提取代码中的注释，并自动生成一份完整的API文档。传统的一些JavaScript文档生成项目，比如jsdoc，只能生成比较简单的文档，无法很好地满足现在的新需求。本文研究对JavaScript源码中的注释进行解析，然后提取有用的API信息，并最后生成一个完整的文档页面供读者阅读。解析过程充分考虑了JavaScript语言的灵活特性，让JavaScript源码作者可以快速地为自己的代码生成对应的文档。同时为了方便用户进行文档生成操作，使用C#开发一个WinForm软件。生成的文档是一个普通的网页，用户可以自定义文档界面模板。生成的文档可以放在ASP.NET服务器上直接运行。读者可以在线阅读文档，并在文档的任何一页添加评论。关键词：JavaScript,API,文档生成,WinFormAbstractJavaScriptisthemostpopularscriptlanguagenowadays,whichisdesignedasasimpleobject-basedscriptlanguagetoprovidetheabilityofinteractionforwebpagesatfirst.ButalongwiththeappearanceofnewwebstandardsandthepopularityofsomeJavaScriptclientslikeNodejs,theusageofJavaScriptincreasessoonandtheJavaScriptprojectsbecomemorecomplex,whichleadstonewrequirementofJavaScriptdocumentationaswell.ToavoidauthorswritingAPIDocumentwordbyword,thereshouldbeapowerfultooltoexportanAPIdocumentfromthesourcecodeautomatically.ThetraditionalrelatedprojectssuchasJsdocshowtheirshortcomingwhenmeetingnewrequirements.ThisarticlefocusesonanalyzingsourcecodeofJavaScriptandthengeneratingafullAPIdocument.TheanalyzingprogramisfitforJavaScript,whichcansavealotoftimeforJavaScriptauthors.ThisarticlealsotalksaboutdevelopingaprogramofWinFormtomakeiteasiertooperate.Ontheotherhand,userscancustomthetemplatesofdocumentifneeded.ThegeneratedAPIdocumentcanrunonASP.NETserverdirectly.Readerscanviewthedocumentonlineandleavetheircommentsonanypage.Keywords：JavaScript,API,DocumentGenerator,WinForm目录摘要IAbstractI第一章绪论31.1研究开发的目的31.2国内外研究发展现状41.3研究开发的基本目标41.4本文的组织结构5第二章方法与技术62.1软件运行环境62.1.1客户端环境要求62.1.2服务器环境要求62.2WinForm简介62.3ASP.NET简介72.4AJAX简介72.5编译原理82.6系统构架:B/S构架82.7主要开发语言92.8开发工具92.8.1VisualStudio201092.8.2Firebug9第三章需求分析103.1软件主体103.1.1用例图103.1.2新建和保存项目103.1.3编辑项目103.1.4编译项目113.2生成的文档界面113.3用于在线可评论的文档123.4文档调试工具12第四章系统设计实现134.