JS-JSDoc】的更多相关文章

在上一节介绍了语法树的结构,本节则介绍如何解析标记组成语法树. 对应的源码位于 src/compiler/parser.ts. 入口函数 要解析一份源码,输入当然是源码内容(字符串),同时还提供路径(用于报错).语言版本(比如ES3 和 ES5 在有些细节不同). createSourceFile 是负责将源码解析为语法树的入口函数,用户可以直接调用:比如 ts.createSourceFile(‘<stdio>’, 'var xld;'). export function createSou…
本文经作者授权,翻译总结自 TypeScript Team 的成员 orta 的个人博客 <Understanding TypeScript's Popularity>. 原作者: orta 原文链接:https://orta.io/notes/js/why-typescript 翻译:ycaptain TypeScript 是一种非常受欢迎的 JavaScript 语言扩展.它在现有的 JavaScript 语法之上加入了一层类型层,而这一层即使被删除,也丝毫不会影响运行时的原有表现.许多人…
============== js 点击事件后没方法名,调用有方法名 document.getElementById('lind').onclick=abc;//传统的id选择器 中没有# 哦 function abc(){ alert(1);} 调用 :abc(); css的属性的:  在 js 中用=‘xx’ ================== 安装方法有多种.我这使用以一种, 1.安装node 2.在 dos 命令中 输入:npm install jsdoc@"<=3.3.0&qu…
JSDoc是一个根据javascript文件中注释的信息,生成API文档的工具.生成的文档是html文件.类似JavaDoc和PHPDoc. 用法 /** 一坨注释之类的 */JSDoc会从/**开头的注释中抽取信息.用/*,/***开头的注释会被JSDoc忽略.如 /** This is a description of the foo function. */ function foo() { } /** * Represents a book. * @constructor * @para…
官方文档 http://usejsdoc.org/ - sublime插件 https://github.com/spadgos/sublime-jsdocs - 生成文档 生成html: (1)安装:npm install jsdoc -g (2)执行:jsdoc test.js 生成markdown: (1)安装:npm install jsdoc-to-markdown -g (2)执行:jsdoc2md text.js > api.md - 块标签 对文件进行描述 @author --…
1.全局安装jsdoc,需要先安装node环境哦~ npm install -g jsdoc 2.在项目根目录新建文件conf.json,内容如下: { "tags": { "allowUnknownTags": true, // 指定所用词典 "dictionaries": [ "jsdoc" ] }, // 查找文件的深度 需要用 -r 参数 "recurseDepth": 10, "sour…
命令名描述 @param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而且在将来的代码版本中将彻底删除.要避免使用这段代码@see 创建一个HTML链接,指向指定类的描述@version 指定发布版本@requires 创建一个HTML链接,指向这个类所需的指定类@throws @exception 描述函数可能抛出的异常的类型{@link} 创建一个HTML链接,指向指定的类…
TypeScript can help you with your plain JavaScript files if you add a simple //@ts-check comment. Then you can enhance the experience by add proper JSDocs to describe your functions which will feed type information into TypeScript and give you a deve…
作者:小爝链接:https://www.zhihu.com/question/30274750/answer/118846177来源:知乎著作权归作者所有,转载请联系作者获得授权. 1,如何编写健壮的javascript代码,鲁棒性,简单总结几条我觉得是常识的事:1.1 一个javascript库最好的实现方式是占用最少的命名空间,比如window对象上或者global对象上只占用一个引用.1.2 健壮的js程序对输入都会有完善的类型检查和异常处理,边界值的判断.1.3 对js的几种继承方式要足…
一.javascript注释规范 我们在编写javascript文件的时候,一般会添加一些注释.例如一些文件.类.方法和属性都应该用合适的标记和类型进行注释.这里不但方便我们的阅读,也能养成一个好的习惯.更大的好处是,我们可以根据这些注释生成帮助文档. 二.JSDoc 3 JSDoc 3是一个生成为Javascript生成API文档的工具.下载地址为:https://github.com/jsdoc3/jsdoc .使用JSDoc 3 我们需要有Node.js环境.Node.js安装好之后,我们…
有时往往我们需要建一个文档来记录js中的一些代码注释,比如一些公共的函数,又或者一些类,在团队合作中,文档接口也是必不可少的,传统的方式多少有些不便,这里介绍一个工具,它叫JSDOC,它可以用来将注释生成文档. 虽然说是说它可以把注释生成文档,但是也不是什么注释都可以的,我们需要按照它的规范来写. 首先我们通过npm来下载它. npm install jsdoc -g JSDOC的格式是这样的. /** * 两个数相加* @param {number} num1 加法* @param {numb…
注释 介绍 作用 合作分享:方便他人阅读,便于分享 沉淀总结:容易忘记代码,自己总结沉淀 形式 1.// 双斜杠 2./**/斜杠星号 常用标签 标签 描述 @module 标明当前文件模块,在这个文件中的所有成员将被默认为属于此模块,除非另外标明 @submodule 针对模块的划分,处于@module之下 @class 标示一个类或者一个函数 @constructor 当使用对象字面量形式定义类时,可使用此标签标明其构造函数 @callback 标明此方法是一个回调函数 @event 标明一…
nodeJS使用: 直接:npm install jsdoc -g使用:jsdoc [name].js 简介 JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档.对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 JavaDoc 很像,没错,JsDoc Toolkit 就是基于 JavaDoc 开发的. 下载地址 http://code.google.com/p/jsdoc-toolki…
写在前面 记得当时刷笔试题的时候有了解过“前端工程化”,无非就是用自动化工具帮助开发人员完成一些小细节,提高工作效率之类的,不过当时可没想到可维护性这么远 构建项目 -> 模块化开发 -> 复用 -> 测试 -> 调试 -> 验证 -> 发布 -> 版本控制,这整个流程的很多环节都可以用自动化工具解放人力,提高项目的可维护性 一.自动化的优缺点 js开发中使用自动构建系统的优缺点如下: 1.优点 自动源码控制能够区分清楚用于调试的代码和将来发布的代码,开发阶段不必…
在前面的博文中探讨自动化工程问题时,写过基于NodeJS的,使用gulp.grunt的jsdoc插件实现文档自动化.本文探讨基于java环境的自动化实现. 一.Java安装与环境配置 关于Java的安装与环境配置,可以参考博文YUI Compressor for Sublime text2 二.jsdoc-tookit下载与使用 下载链接:jsdoc-tookit,现在地址可能被墙了,可以通过搜索其它渠道下载.下面完成后,解压到工作目录即可. -> cmd -> 命令行窗口 -> cd到…
Node.js is a platform for building fast and scalable server applications using JavaScript. Node.js is the runtime and NPM is the Package Manager for Node.js modules. VS Code has support for the JavaScript and TypeScript languages out-of-the-box as we…
几天工作上需要文档化一些Javascript东西,所以在找一些JS文档化工具,以下分析几种工具. 1.JSDoc-toolkit 一开始还想用这个工具,但后来在解析生成文档时候,出现了很严重的错误,还存在其他问题. 问题1:闭包存在时候,解析出错(很严重) ,导致几乎就不能用来做JS文档化. 问题2:在Javascript部分,注释怎么写都不对,感觉这个工具使用起来很困难 问题3:如果是静态函数或prototype设置函数,就会出问题,warning错误,然后生成的文档很怪异 之所以会出现上面种…
Sublime Text 是每个开发者工具箱中都应该有的一个强大的应用.它是一个跨平台的.高定制化的.高级的文本编辑器,在功能强大的 集成开发环境(众所周知地消耗资源)和类似于 Vim 或 Emacs 的命令行编辑器(学习成本非常高)之间取得了很好的平衡. 使得 Sublime 如此强大的原因之一就是其可扩展的插件架构.开发者可以很容易地扩展 Sublime 的核心功能,添加一些新特性,比如补全代码.嵌入远程接口文档.Sublime Text 不带有可以启用的插件 – 它们通常通过第三方包管理器…
最佳原则 坚持制定好的代码规范. 无论团队人数多少,代码应该同出一门. 项目命名 全部采用小写方式, 以下划线分隔. 例:my_project_name 目录命名 参照项目命名规则: 有复数结构时,要采用复数命名法. 例:scripts, styles, images, data_models JS文件命名 参照项目命名规则. 例:account_model.js HTML文件命名 参照项目命名规则. 例:error_report.html 语法 缩进使用soft tab(4个空格): 嵌套的节…
近来前端组小盆友开发的类库越来越多,很多情况下彼此不知道写了些什么方法,为了更好的合作提高工作效率,找了个比较好的api文档生成方法.使用jsdoc-toolkit来自动生成js api文档. 一. 环境搭建 1) 首先要安装java环境,如果不太了解的参看:http://jingyan.baidu.com/article/e75aca85b29c3b142edac6a8.html 2) 安装jsdoc-toolkit 下载地址:http://code.google.com/p/jsdoc-to…
Backbone.js的技巧和模式 Backbone.js的技巧和模式   本文由白牙根据Phillip Whisenhunt的<Backbone.js Tips And Patterns>所译,整个译文带有我自己的理解与思想,如果译得不好或不对之处还请同行朋友指点.如需转载此译文,需注明英文出处:http://coding.smashingmagazine.com/2013/08/09/backbone-js-tips-patterns/,以及作者相关信息 作者:Phillip Whisen…
背景: 随着开发团队规模不断发展壮大,在人员增加的同时也带来了协作成本的增加,业务项目越来越多,类型也各不相同.常见的类型有组件类.活动类.基于React+redux的业务项目.RN项目.Node.js项目等等.如果想要对每个项目进行一些规范的约束比如Git提交规范.Javascript规范简直难于登天.所有的这些,只因为缺少一个好用的工程化工具.从项目创建.开发.构建.代码规范检查到最终项目上线,通过CLI可以提升效率,同时保障开发规范的实施. Node.js实现CLI的基本原理 关键点在于p…
译者按: 代码要有规范的注释,遵从jsDoc规则来注释可以生成有用的文档. 原文: Generate docs and host it with JSDoc and GitHub Pages 译者: Fundebug 为了保证可读性,本文采用意译而非直译,并且对源代码进行了大量修改.另外,本文版权归原作者所有,翻译仅用于学习. 今天,我来分享如何快速生成JavaScript代码的文档,并且使用Github pages发布. 我首先创建一个示例类JokeMachine,它存储一个笑话列表,调用sa…
免费视频播放器videojs中文教程 Video.js是一款web视频播放器,支持html5和flash两种播放方式.更多关于video.js的介绍,可以访问官方网站介绍,我之前也写过一篇关于video.js的使用心得,有兴趣的可以点这里 , 阅读的人数还蛮多的,有些热心的读者甚至还给过我小额打赏,钱虽不多,但是很感动.最几天又收到几位网友的私信,问一些关于videojs使用方面的问题.我自己都不记得videojs长什么模样了,出于别人对我的信任,又回头看了一遍上一篇文章,还是2014年的时候写…
HBuilder有通行的js扫描分析提示,大部分js库都可以方便的提示.但js是一门超级灵活的语言,通行分析有时分析的不够完美,如果对框架做单独优化配置,可以有更好的提示.DCloud官方对jquery.zepto.angular.bootstrap.微信JS SDK和MUI等框架专门做了优化.但js框架太多,而我们精力有限,所以我们也提供了扩展方案,大家可以一起来完善js框架的优化提示. 官方优化的js库的提示挂载方法:使用jquery.mui等框架,如果工程下存在标准的框架文件,或者HTML…
背景: 随着开发团队规模不断发展壮大,在人员增加的同时也带来了协作成本的增加,业务项目越来越多,类型也各不相同.常见的类型有组件类.活动类.基于React+redux的业务项目.RN项目.Node.js项目等等.如果想要对每个项目进行一些规范的约束比如Git提交规范.Javascript规范简直难于登天.所有的这些,只因为缺少一个好用的工程化工具.从项目创建.开发.构建.代码规范检查到最终项目上线,通过CLI可以提升效率,同时保障开发规范的实施. Node.js实现CLI的基本原理 关键点在于p…
最近在跟着视频敲项目时,代码提示出现很多奇奇怪怪的错误提示,百度了一下是eslintrc.js文件没有配置相关命令,ESlint的语法检测真的令人抓狂,现在总结一下这些命令的解释,方便以后查阅. 默认eslint规则: 代码末尾不能加分号 ;(强迫症的我受不了哭) 代码中不能存在多行空行:(这个我更也忍不了大哭) tab键不能使用,必须换成两个空格:(超级不习惯) 代码中不能存在声明了但未使用的变量:(这个我觉得可以有) 最简单的方法,关闭eslint检测得意,其实很简单,把 build/web…
Grunt-jsdoc生成JS API文档 具体的请看官网 https://github.com/krampstudio/grunt-jsdoc 一:首先确保本机电脑上是否已经安装了nodejs和npm.具体安装过程可以看如下: http://www.cnblogs.com/tugenhua0707/p/3497488.html 二: 在安装grunt-jsodc之前,我们先要安装grunt,因此我在F盘下 新建文件夹gruntJSDoc 其中根目录里面新建一个package.json文件,内容…
一.规范目的 为提高团队协作效率,便于前端后期优化维护,输出高质量的文档. 二.基本准则 符合web标准,结构表现行为分离,兼容性优良.页面性能方面,代码要求简洁明了有序, 尽可能的减小服务器负载,保证最快的解析速度. 项目的维护和二次开发可能是直接或间接的团队合作,所以创建易维护的代码是一个项目成功与否的关键,易维护的代码意味着具有如下特性: 阅读性好:如良好的注释和命名规范,有文档 具有一致性:看起来如同一个人编写 代码的松耦合,高度模块化:将页面内的元素视为一个个模块,相互独立,尽量避免耦…
免费视频播放器videojs中文教程 Video.js是一款web视频播放器,支持html5和flash两种播放方式.更多关于video.js的介绍,可以访问官方网站介绍,我之前也写过一篇关于video.js的使用心得,有兴趣的可以点这里 , 阅读的人数还蛮多的,有些热心的读者甚至还给过我小额打赏,钱虽不多,但是很感动.最几天又收到几位网友的私信,问一些关于videojs使用方面的问题.我自己都不记得videojs长什么模样了,出于别人对我的信任,又回头看了一遍上一篇文章,还是2014年的时候写…